Add docstrings

python_modules/dagster/dagster/_core/definitions/antlr_asset_selection/antlr_asset_selection.py

@@ -1,5 +1,6 @@
 from antlr4 import CommonTokenStream, InputStream
 
+from dagster._annotations import experimental
 from dagster._core.definitions.antlr_asset_selection.generated.AssetSelectionLexer import (
     AssetSelectionLexer,
 )
@@ -8,6 +9,7 @@
 )
 
 
+@experimental
 class AntlrAssetSelection:
     def __init__(self, selection_str: str):
         lexer = AssetSelectionLexer(InputStream(selection_str))

python_modules/dagster/dagster/_core/definitions/antlr_asset_selection/fix_imports.py

@@ -1,4 +1,9 @@
 def fix_imports(file_path):
+    """This function fixes the imports in the files generated by ANTLR.
+    Some files have imports that check for older python versions which
+    causes issues with the linter. This function removes the if/else check
+    and only keeps the import statement that works for our python version.
+    """
     with open(file_path, "r") as file:
         lines = file.readlines()
     updated_lines = []
@@ -16,6 +21,10 @@ def fix_imports(file_path):
 
 
 def add_lines_to_start(file_path, lines_to_add):
+    """This function adds lines to the start of a file. This is used to
+    add `flake8: noqa` and `type: ignore` to the files generated by ANTLR
+    to ignore linter errors caused by ANTLR.
+    """
     with open(file_path, "r") as file:
         original_content = file.readlines()
 
@@ -35,7 +44,7 @@ def add_lines_to_start(file_path, lines_to_add):
 for file in files:
     fix_imports(file)
     add_lines_to_start(file, ["# flake8: noqa\n"])
-    if file == "AssetSelectionParser.py":
+    if file == "generated/AssetSelectionParser.py":
         add_lines_to_start(
             file,
             [

python_modules/dagster/dagster/_core/definitions/antlr_asset_selection/generated/AssetSelectionParser.py

@@ -1,3 +1,4 @@
+# type: ignore
 # flake8: noqa
 # Generated from AssetSelection.g4 by ANTLR 4.13.2
 # encoding: utf-8