ts-backend-check 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

ts_backend_check/__init__.py

@@ -1,7 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
-__version__ = "1.0.0"
+from ts_backend_check.checker import TypeChecker
+from ts_backend_check.cli.main import main
 
-from .checker import TypeChecker
-from .cli import cli
-
-__all__ = ["cli", "TypeChecker"]
+__all__ = ["main", "TypeChecker"]

ts_backend_check/checker.py

@@ -5,9 +5,9 @@ Main module for checking Django models against TypeScript types.
 
 from typing import Dict, List, Set
 
-from .django_parser import extract_model_fields
-from .typescript_parser import TypeScriptParser
-from .utils import snake_to_camel
+from ts_backend_check.parsers.django_parser import extract_model_fields
+from ts_backend_check.parsers.typescript_parser import TypeScriptParser
+from ts_backend_check.utils import snake_to_camel
 
 
 class TypeChecker:

ts_backend_check/cli/__init__.py

@@ -1,8 +1,4 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
-"""
-CLI package for ts-backend-check.
-"""
+from ts_backend_check.cli.main import main
 
-from .main import cli
-
-__all__ = ["cli"]
+__all__ = ["main"]

ts_backend_check/cli/main.py

@@ -3,56 +3,84 @@
 Setup and commands for the ts-backend-check command line interface.
 """
 
+import argparse
 import sys
+from pathlib import Path
 
-import click
+from ts_backend_check.checker import TypeChecker
 
-from ..checker import TypeChecker
 
-
-@click.group()
-@click.version_option()
-def cli():
-    """
-    TS Backend Check is a Python package used to check TypeScript types against their corresponding backend models.
+def main() -> None:
     """
-    pass
+    The main check function to compare a the methods within a backend model to a corresponding TypeScript file.
 
+    Notes
+    -----
+    The available command line arguments are:
+    - --backend-model-file (-bmf): Path to the backend model file (e.g. Python class)
+    - --typescript-file (-tsf): Path to the TypeScript interface/type file
 
-@cli.command()
-@click.argument("backend_model", type=click.Path(exists=True))
-@click.argument("typescript_file", type=click.Path(exists=True))
-def check(backend_model: str, typescript_file: str):
+    Examples
+    --------
+    >>> ts-backend-check -bmf <backend-model-file> -tsf <typescript-file>
     """
-    Check TypeScript types against backend models.
+    # MARK: CLI Base
 
-    This command checks if all fields from the backend model are properly represented
-    in the TypeScript types file. It supports marking fields as backend-only using
-    special comments in the TypeScript file.
+    ROOT_DIR = Path(__file__).cwd()
+    parser = argparse.ArgumentParser(
+        prog="ts-backend-check",
+        description="Checks the types in TypeScript files against the corresponding backend models.",
+        epilog="Visit the codebase at https://github.com/activist-org/ts-backend-check to learn more!",
+        formatter_class=lambda prog: argparse.HelpFormatter(prog, max_help_position=60),
+    )
 
-    Parameters
-    ----------
-    backend_model : str
-        The path to the backend model file (e.g. Python class).
+    parser._actions[0].help = "Show this help message and exit."
 
-    typescript_file : str
-        The path to the TypeScript interface/type file.
+    parser.add_argument(
+        "-bmf",
+        "--backend-model-file",
+        help="Path to the backend model file (e.g. Python class).",
+    )
+    parser.add_argument(
+        "-tsf",
+        "--typescript-file",
+        help="Path to the TypeScript interface/type file.",
+    )
 
-    Examples
-    --------
-    ts-backend-check check src/models/user.py src/types/user.ts
-    """
-    checker = TypeChecker(models_file=backend_model, types_file=typescript_file)
-    if missing := checker.check():
-        click.echo("Missing TypeScript fields found:")
-        click.echo("\n".join(missing))
-        click.echo(
-            f"\nPlease correct the {len(missing)} fields above to have backend models and frontend types fully synced."
+    # MARK: Setup CLI
+
+    args = parser.parse_args()
+    backend_model_file_path = ROOT_DIR / args.backend_model_file
+    ts_file_path = ROOT_DIR / args.typescript_file
+
+    if not backend_model_file_path.is_file():
+        print(
+            f"{args.backend_model_file} that should contain the backend models does not exist. Please check and try again."
+        )
+
+    elif not ts_file_path.is_file():
+        print(
+            f"{args.typescript_file} file that should contain the TypeScript types does not exist. Please check and try again."
         )
-        sys.exit(1)
 
-    click.echo("All model fields are properly typed in TypeScript!")
+    else:
+        checker = TypeChecker(
+            models_file=args.backend_model_file,
+            types_file=args.typescript_file,
+        )
+
+        if missing := checker.check():
+            print("Missing typescript fields found: ")
+            print("\n".join(missing))
+
+            field_or_fields = "fields" if len(missing) > 1 else "field"
+            print(
+                f"\nPlease fix the {len(missing)} {field_or_fields} to have the backend models synced with the typescript interfaces."
+            )
+            sys.exit(1)
+
+        print("All models are synced with their corresponding TypeScript interfaces.")
 
 
 if __name__ == "__main__":
-    cli()
+    main()

ts_backend_check/parsers/django_parser.py

@@ -0,0 +1,113 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""
+Module for parsing Django models and extracting field information.
+"""
+
+import ast
+from typing import Dict, Set
+
+
+class DjangoModelVisitor(ast.NodeVisitor):
+    """
+    AST visitor to extract fields from Django models.
+    """
+
+    DJANGO_FIELD_TYPES = {
+        "Field",
+        "CharField",
+        "TextField",
+        "IntegerField",
+        "BooleanField",
+        "DateTimeField",
+        "ForeignKey",
+        "ManyToManyField",
+        "OneToOneField",
+        "EmailField",
+        "URLField",
+        "FileField",
+        "ImageField",
+        "DecimalField",
+        "AutoField",
+    }
+
+    def __init__(self) -> None:
+        self.models: Dict[str, Set[str]] = {}
+        self.current_model: str | None = None
+
+    def visit_ClassDef(self, node: ast.ClassDef) -> None:
+        """
+        Check class definitions, specifically those that inherit from other classes.
+
+        Parameters
+        ----------
+        node : ast.ClassDef
+            A class definition from Python AST (Abstract Syntax Tree).
+            It contains information about the class, such as its name, base classes, body, decorators, etc.
+        """
+        # Only process classes that inherit from something.
+        if node.bases:
+            self.current_model = node.name
+            if self.current_model not in self.models:
+                self.models[self.current_model] = set()
+
+            self.generic_visit(node)
+
+        self.current_model = None
+
+    def visit_Assign(self, node: ast.Assign) -> None:
+        """
+        Check assignment statements within a class.
+
+        Parameters
+        ----------
+        node : ast.Assign
+            An assignment definition from Python AST (Abstract Syntax Tree).
+            It represents an assignment statement (e.g., x = 42).
+        """
+        if not self.current_model:
+            return
+
+        for target in node.targets:
+            if (
+                isinstance(target, ast.Name)
+                and not target.id.startswith("_")
+                and isinstance(node.value, ast.Call)
+                and hasattr(node.value.func, "attr")
+            ) and any(
+                field_type in node.value.func.attr
+                for field_type in self.DJANGO_FIELD_TYPES
+            ):
+                self.models[self.current_model].add(target.id)
+
+
+def extract_model_fields(models_file: str) -> Dict[str, Set[str]]:
+    """
+    Extract fields from Django models file.
+
+    Parameters
+    ----------
+    models_file : str
+        A models.py file that defines Django models.
+
+    Returns
+    -------
+    Dict[str, Set[str]]
+        The fields from the models file extracted into a dictionary for future processing.
+    """
+    with open(models_file, "r", encoding="utf-8") as f:
+        content = f.read().strip()
+        # Skip any empty lines at the beginning
+        while content.startswith("\n"):
+            content = content[1:]
+
+    try:
+        tree = ast.parse(content)
+    except SyntaxError as e:
+        raise SyntaxError(
+            f"Failed to parse {models_file}. Make sure it's a valid Python file. Error: {str(e)}"
+        ) from e
+
+    visitor = DjangoModelVisitor()
+    visitor.visit(tree)
+
+    return visitor.models

ts_backend_check/parsers/typescript_parser.py

@@ -0,0 +1,105 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""
+Module for parsing TypeScript interfaces and types.
+"""
+
+import re
+from dataclasses import dataclass
+from typing import Dict, List, Set
+
+
+@dataclass
+class TypeScriptInterface:
+    """
+    Represents a TypeScript interface with its fields and parent interfaces.
+    """
+
+    name: str
+    fields: Set[str]
+    parents: List[str]
+
+
+class TypeScriptParser:
+    """
+    Parser for TypeScript interface files.
+
+    Parameters
+    ----------
+    file_path : str
+        The file path for the TypeScript file to parse.
+    """
+
+    def __init__(self, file_path: str) -> None:
+        self.file_path = file_path
+        with open(file_path, "r", encoding="utf-8") as f:
+            self.content = f.read()
+
+    def parse_interfaces(self) -> Dict[str, TypeScriptInterface]:
+        """
+        Parse TypeScript interfaces from the file.
+
+        Returns
+        -------
+        Dict[str, TypeScriptInterface]
+            The interface parsed into a dictionary for future processing.
+        """
+        interfaces = {}
+        interface_pattern = (
+            r"(?:export\s+|declare\s+)?interface\s+(\w+)"
+            r"(?:\s+extends\s+([^{]+))?\s*{([\s\S]*?)}"
+        )
+
+        for match in re.finditer(interface_pattern, self.content):
+            name = match.group(1)
+            parents = (
+                [p.strip() for p in match.group(2).split(",")] if match.group(2) else []
+            )
+            fields = self._extract_fields(match.group(3))
+
+            interfaces[name] = TypeScriptInterface(name, fields, parents)
+
+        return interfaces
+
+    def get_backend_only_fields(self) -> Set[str]:
+        """
+        Extract fields marked as backend-only in comments.
+
+        Returns
+        -------
+        Set[str]
+            The field names that are marked with a backend-only identifier to ignore them.
+        """
+        patterns = [
+            r"//.*?Note:\s*(\w+)\s+is\s+backend\s+only",
+            r"//.*?(\w+)\s+is\s+backend\s+only",
+            r"//\s*@backend-only\s+(\w+)",
+            r"//.*?backend-only:\s*(\w+)",
+        ]
+        return {
+            match for pattern in patterns for match in re.findall(pattern, self.content)
+        }
+
+    @staticmethod
+    def _extract_fields(interface_body: str) -> Set[str]:
+        """
+        Extract field names from interface body.
+
+        Parameters
+        ----------
+        interface_body : str
+            A string representation of the interface body of the model.
+
+        Returns
+        -------
+        Set[str]
+            The field names from the model interface body.
+        """
+        fields = set()
+
+        # Regular fields
+        fields.update(re.findall(r"(?://[^\n]*\n)*\s*(\w+)\s*[?]?\s*:", interface_body))
+
+        # Readonly fields
+        fields.update(re.findall(r"readonly\s+(\w+)\s*[?]?\s*:", interface_body))
+
+        return fields

ts_backend_check/utils.py

@@ -6,7 +6,7 @@ Utility functions for ts-backend-check.
 
 def snake_to_camel(input_str: str) -> str:
     """
-    Convert snake_case to camelCase.
+    Convert snake_case to camelCase while preserving existing camelCase components.
 
     Parameters
     ----------
@@ -17,6 +17,23 @@ def snake_to_camel(input_str: str) -> str:
     -------
     str
         The camelCase version of the input string.
+
+    Examples
+    --------
+    hello_world -> helloWorld, alreadyCamelCase -> alreadyCamelCase
     """
-    components = input_str.split("_")
-    return components[0] + "".join(x.title() for x in components[1:])
+    if not input_str or input_str.startswith("_"):
+        return input_str
+
+    words = input_str.split("_")
+    result = words[0].lower()
+
+    for word in words[1:]:
+        if word:
+            if any(c.isupper() for c in word[1:]):
+                result += word[0].upper() + word[1:]
+
+            else:
+                result += word[0].upper() + word[1:].lower()
+
+    return result

{ts_backend_check-1.0.0.dist-info → ts_backend_check-1.1.0.dist-info}/METADATA

@@ -1,21 +1,39 @@
 Metadata-Version: 2.4
 Name: ts-backend-check
-Version: 1.0.0
-Summary: ts-backend-check is a Python package used to check TypeScript types against their corresponding backend models to assure that all fields have been accounted for.
+Version: 1.1.0
+Summary: Check TypeScript types against their corresponding backend models to assure that all fields have been accounted for.
 Home-page: https://github.com/activist-org/ts-backend-check
 Author: ts-backend-check developers
-Author-email: andrew.t.mcallister@gmail.com
+Author-email: team@activist.org
+License: : OSI Approved :: GNU License
+Keywords: backend,typescript,validation,ci,cli
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: click>=8.1
+Dynamic: author
 Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license-file
 Dynamic: requires-python
+Dynamic: summary
 
 <div align="center">
-  <a href="https://github.com/activist-org/ts-backend-check"><img src="https://raw.githubusercontent.com/activist-org/ts-backend-check/main/.github/resources/TSBECheckGitHubBanner.png" width=1024 alt="TSBE Check logo"></a>
+  <a href="https://github.com/activist-org/ts-backend-check"><img src="https://raw.githubusercontent.com/activist-org/ts-backend-check/main/.github/resources/TSBackendCheckGitHubBanner.png" width=1024 alt="TS Backend Check logo"></a>
 </div>
 
 [![rtd](https://img.shields.io/readthedocs/ts-backend-check.svg?label=%20&logo=read-the-docs&logoColor=ffffff)](http://ts-backend-check.readthedocs.io/en/latest/)
@@ -51,6 +69,11 @@ Dynamic: requires-python
 pip install ts-backend-check
 ```
 
+### Command Options
+
+- `backend-model-file` (`bmf`): Path to the backend model file (e.g. Python class)
+- `typescript-file` (`tsf`): Path to the TypeScript interface/type file
+
 ### Basic Usage
 
 The CLI provides a simple interface to check TypeScript types against backend models:
@@ -60,29 +83,17 @@ The CLI provides a simple interface to check TypeScript types against backend mo
 ts-backend-check --help
 
 # Check a TypeScript type against a backend model:
-ts-backend-check check <typescript_file> <backend_model>
+ts-backend-check -bmf <backend-model-file> -tsf <typescript-file>
 
 # Example command:
-ts-backend-check check src/types/user.ts src/models/user.py
-```
-
-### Command Options
-
-- `check`: Compare TypeScript types with backend models
-  - `typescript_file`: Path to the TypeScript interface/type file
-  - `backend_model`: Path to the backend model file (e.g. Python class)
-
-### Version Information
-
-```bash
-ts-backend-check --version
+ts-backend-check -bmf src/models/user.py -tsf src/types/user.ts
 ```
 
 <a id="contributing"></a>
 
 # Contributing [`⇧`](#contents)
 
-<a href="https://matrix.to/#/#activist_community:matrix.org"><img src="https://raw.githubusercontent.com/activist-org/Organization/main/resources/images/logos/MatrixLogoGrey.png" height="50" alt="Public Matrix Chat" align="right"></a>
+<a href="https://matrix.to/#/#activist_community:matrix.org"><img src="https://raw.githubusercontent.com/activist-org/Organization/main/resources/images/logos/MatrixLogoGrey.png" width="175" alt="Public Matrix Chat" align="right"></a>
 
 activist uses [Matrix](https://matrix.org/) for internal communication. You're more than welcome to [join us in our public chat rooms](https://matrix.to/#/#activist_community:matrix.org) to share ideas, ask questions or just say hi to the team :)
 

ts_backend_check-1.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+ts_backend_check/__init__.py,sha256=HSiEqWvU3Q4a6D7tYsoq3-B-g1HdUOGngEeGV45j8ak,172
+ts_backend_check/checker.py,sha256=svfIJ9lNaSSy-zSGsM4wYD9Z9JK_xL5l6JA-w9pdf_o,5791
+ts_backend_check/django_parser.py,sha256=CFg4-zV5BsVhuq-nVQEYD9nS25JSaHbIs2Xr3LE3KWY,3241
+ts_backend_check/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
+ts_backend_check/utils.py,sha256=N9_25_wW2g3dkmGGLWHQj_AHsXI9Rx2XqRnYxT5i2Rk,897
+ts_backend_check/cli/__init__.py,sha256=wJK9tO9MtI10L0xRjrk7WP_qZZRBjbFw1U9jJbIbX7I,108
+ts_backend_check/cli/main.py,sha256=C3JCGv4QNo-xlp-MlCK49nzGAzuwWYDYLBi-OS7bvXQ,2712
+ts_backend_check/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ts_backend_check/parsers/django_parser.py,sha256=CFg4-zV5BsVhuq-nVQEYD9nS25JSaHbIs2Xr3LE3KWY,3241
+ts_backend_check/parsers/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
+ts_backend_check-1.1.0.data/data/requirements.txt,sha256=0FbFr7FTG31FEs_FMsN3MrAIFJIeGdDC6POOOb2FeA0,134
+ts_backend_check-1.1.0.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ts_backend_check-1.1.0.dist-info/METADATA,sha256=XSvF56GNwNfAJa1e8l1pa42Jz_n_9hG8TmR6yDx-N_A,9734
+ts_backend_check-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ts_backend_check-1.1.0.dist-info/entry_points.txt,sha256=QeY7RJu20otBnQlhMMZxPL8nB3mP3M3U3h3nOlSFWSU,68
+ts_backend_check-1.1.0.dist-info/top_level.txt,sha256=VzfNWQ3fPNdl-OBdtUKsUWR8Asdd27E3OJNUg2oQU8Y,17
+ts_backend_check-1.1.0.dist-info/RECORD,,

ts_backend_check-1.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ts-backend-check = ts_backend_check.cli.main:main

ts_backend_check-1.0.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-ts_backend_check/__init__.py,sha256=5Y_YDmaFl9cjVy1GqGeml-QaPUpcJyWgjCYe_vJoHvw,156
-ts_backend_check/checker.py,sha256=8mLtLBt6ok2cDgt-3u8yb3hClf-3ojU8zIsqL2z_GdQ,5727
-ts_backend_check/django_parser.py,sha256=CFg4-zV5BsVhuq-nVQEYD9nS25JSaHbIs2Xr3LE3KWY,3241
-ts_backend_check/typescript_parser.py,sha256=BqBGOjsf-Wlh6ceaK-G2vLm5AMiEiwX-XnJQrr8P-gQ,2885
-ts_backend_check/utils.py,sha256=Kfa6ZvjnsGrGJJX18FhfzmQtjMrjPwfECZiZL4zgGRQ,475
-ts_backend_check/cli/__init__.py,sha256=bxThVZZgFRXoWgZ4pasljY6ATZPTJVh_KeBebweDJb0,129
-ts_backend_check/cli/main.py,sha256=RUJsonWBUnCqg93ayuDo0LJYhCLKuVb9V9Ycx5cbts4,1636
-ts_backend_check-1.0.0.data/data/requirements.txt,sha256=0FbFr7FTG31FEs_FMsN3MrAIFJIeGdDC6POOOb2FeA0,134
-ts_backend_check-1.0.0.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ts_backend_check-1.0.0.dist-info/METADATA,sha256=1hA_CrBvSqePiw3G0ZBAvm5kEmGBRSYHGlUOmsagJnw,9084
-ts_backend_check-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ts_backend_check-1.0.0.dist-info/entry_points.txt,sha256=6_OttJoqgUr1BZYjy6Rcx5g0iYcwJD2o1c5q_6OcXzw,58
-ts_backend_check-1.0.0.dist-info/top_level.txt,sha256=VzfNWQ3fPNdl-OBdtUKsUWR8Asdd27E3OJNUg2oQU8Y,17
-ts_backend_check-1.0.0.dist-info/RECORD,,

ts_backend_check-1.0.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-ts-backend-check = ts_backend_check:cli