Regenerate semgrep_output_v1.py with atdpy 3.0.1 (#426)

atdpy now honors `<doc text="...">` annotations like atdgen and turns
them into Python docstrings.

- [x] I ran `make setup && make` to update the generated code after
editing a `.atd` file (TODO: have a CI check)
- [x] I made sure we're still backward compatible with old versions of
the CLI.
For example, the Semgrep backend need to still be able to *consume* data
	  generated by Semgrep 1.50.0.
See
https://atd.readthedocs.io/en/latest/atdgen-tutorial.html#smooth-protocol-upgrades
	  Note that the types related to the semgrep-core JSON output or the
	  semgrep-core RPC do not need to be backward compatible!
- [x] Any accompanying changes in `semgrep-proprietary` are approved and
ready to merge once this PR is merged

Author: mjambon

.gitignore

@@ -6,3 +6,7 @@
 *.cmi
 *.cmo
 Language
+
+# Generated by ./scripts/check-backwards-compatibility
+before.txt
+after.txt

Makefile

@@ -38,8 +38,9 @@ force-build:
 .PHONY: build
 build: $(FILES)
 
-# need atdpy >= 2.11.0 to support parametrized types
+# need atdpy >= 3.0.0 to translate <doc text=...> into Python docstrings
 # need atdpy >= 2.12.0 for semgrep_metric.py
+# need atdpy >= 2.11.0 to support parametrized types
 %.py: %.atd
 	atdpy $<
 

semgrep-interfaces.opam

@@ -11,12 +11,12 @@ license: "LGPL-2.1-only"
 
 build: []
 install: []
-          
+
 depends: [
   "atd" {>= "2.6.0"}
-  "atdpy" {>= "2.12.0"}
+  "atdpy" {>= "3.0.0"}
   "atdts" {>= "2.13.0"}
-  "atdgen" {>= "2.10.0"}
+  "atdgen" {>= "3.0.1"}
 ]
 
 #TODO: we don't build on ubuntu or debian ever, and they are not packages there,

semgrep_metrics.py

@@ -265,7 +265,8 @@ def write_option(x: Any) -> Any:
 
 @dataclass
 class SupplyChainConfig:
-    """Original type: supply_chain_config = { ... }"""
+    """Original type: supply_chain_config = { ... }
+    """
 
     _rfu: Optional[int] = None
 
@@ -294,7 +295,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Any_:
-    """Original type: secrets_origin = [ ... | Any | ... ]"""
+    """Original type: secrets_origin = [ ... | Any | ... ]
+    """
 
     @property
     def kind(self) -> str:
@@ -311,7 +313,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Semgrep:
-    """Original type: secrets_origin = [ ... | Semgrep | ... ]"""
+    """Original type: secrets_origin = [ ... | Semgrep | ... ]
+    """
 
     @property
     def kind(self) -> str:
@@ -328,7 +331,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class NoCommunity:
-    """Original type: secrets_origin = [ ... | NoCommunity | ... ]"""
+    """Original type: secrets_origin = [ ... | NoCommunity | ... ]
+    """
 
     @property
     def kind(self) -> str:
@@ -345,7 +349,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class SecretsOrigin:
-    """Original type: secrets_origin = [ ... ]"""
+    """Original type: secrets_origin = [ ... ]
+    """
 
     value: Union[Any_, Semgrep, NoCommunity]
 
@@ -379,7 +384,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class SecretsConfig:
-    """Original type: secrets_config = { ... }"""
+    """Original type: secrets_config = { ... }
+    """
 
     permitted_origins: SecretsOrigin
 
@@ -407,7 +413,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class ProFeatures:
-    """Original type: pro_features = { ... }"""
+    """Original type: pro_features = { ... }
+    """
 
     diffDepth: Optional[int] = None
     numInterfileDiffScanned: Optional[List[Tuple[str, int]]] = None
@@ -440,7 +447,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class CodeConfig:
-    """Original type: code_config = { ... }"""
+    """Original type: code_config = { ... }
+    """
 
     _rfu: Optional[int] = None
 
@@ -469,7 +477,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Intraprocedural:
-    """Original type: analysis_type = [ ... | Intraprocedural | ... ]"""
+    """Original type: analysis_type = [ ... | Intraprocedural | ... ]
+    """
 
     @property
     def kind(self) -> str:
@@ -486,7 +495,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Interprocedural:
-    """Original type: analysis_type = [ ... | Interprocedural | ... ]"""
+    """Original type: analysis_type = [ ... | Interprocedural | ... ]
+    """
 
     @property
     def kind(self) -> str:
@@ -503,7 +513,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Interfile:
-    """Original type: analysis_type = [ ... | Interfile | ... ]"""
+    """Original type: analysis_type = [ ... | Interfile | ... ]
+    """
 
     @property
     def kind(self) -> str:
@@ -520,7 +531,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class AnalysisType:
-    """Original type: analysis_type = [ ... ]"""
+    """Original type: analysis_type = [ ... ]
+    """
 
     value: Union[Intraprocedural, Interprocedural, Interfile]
 
@@ -554,7 +566,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class EngineConfig:
-    """Original type: engine_config = { ... }"""
+    """Original type: engine_config = { ... }
+    """
 
     analysis_type: AnalysisType
     pro_langs: bool
@@ -597,7 +610,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Value:
-    """Original type: value = { ... }"""
+    """Original type: value = { ... }
+    """
 
     features: List[str]
     proFeatures: Optional[ProFeatures] = None
@@ -656,7 +670,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Uuid:
-    """Original type: uuid"""
+    """Original type: uuid
+    """
 
     value: str
 
@@ -677,7 +692,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Sha256:
-    """Original type: sha256"""
+    """Original type: sha256
+    """
 
     value: str
 
@@ -698,7 +714,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class RuleStats:
-    """Original type: rule_stats = { ... }"""
+    """Original type: rule_stats = { ... }
+    """
 
     ruleHash: str
     bytesScanned: int
@@ -733,7 +750,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class FileStats:
-    """Original type: file_stats = { ... }"""
+    """Original type: file_stats = { ... }
+    """
 
     size: int
     numTimesScanned: int
@@ -776,7 +794,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Performance:
-    """Original type: performance = { ... }"""
+    """Original type: performance = { ... }
+    """
 
     numRules: Optional[int] = None
     numTargets: Optional[int] = None
@@ -829,7 +848,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class ParseStat:
-    """Original type: parse_stat = { ... }"""
+    """Original type: parse_stat = { ... }
+    """
 
     targets_parsed: int
     num_targets: int
@@ -866,7 +886,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Finding:
-    """Original type: finding = { ... }"""
+    """Original type: finding = { ... }
+    """
 
     path: str
     line: int
@@ -906,7 +927,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Mcp:
-    """Original type: mcp = { ... }"""
+    """Original type: mcp = { ... }
+    """
 
     deployment_name: Optional[str] = None
     session_id: Optional[str] = None
@@ -1007,7 +1029,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Extension:
-    """Original type: extension = { ... }"""
+    """Original type: extension = { ... }
+    """
 
     machineId: Optional[str] = None
     isNewAppInstall: Optional[bool] = None
@@ -1060,7 +1083,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Error:
-    """Original type: error"""
+    """Original type: error
+    """
 
     value: str
 
@@ -1081,7 +1105,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Errors:
-    """Original type: errors = { ... }"""
+    """Original type: errors = { ... }
+    """
 
     returnCode: Optional[int] = None
     errors: Optional[List[Error]] = None
@@ -1114,7 +1139,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Environment:
-    """Original type: environment = { ... }"""
+    """Original type: environment = { ... }
+    """
 
     version: str
     os: str
@@ -1175,7 +1201,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Datetime:
-    """Original type: datetime"""
+    """Original type: datetime
+    """
 
     value: str
 
@@ -1196,7 +1223,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Payload:
-    """Original type: payload = { ... }"""
+    """Original type: payload = { ... }
+    """
 
     event_id: Uuid
     started_at: Datetime
@@ -1254,7 +1282,8 @@ def to_json_string(self, **kw: Any) -> str:
 
 @dataclass
 class Lang:
-    """Original type: lang"""
+    """Original type: lang
+    """
 
     value: str