CLASPLint 0.2.0__tar.gz → 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/__init__.py +9 -8
  2. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/__main__.py +11 -9
  3. CLASPLint-0.3.0/CLASPLint/comment_checker.py +702 -0
  4. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/dict_key_checker.py +26 -28
  5. CLASPLint-0.3.0/CLASPLint/docstring_checker.py +803 -0
  6. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/function_checker.py +86 -73
  7. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/log_checker.py +160 -41
  8. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/naming_utils.py +39 -29
  9. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/reporter.py +17 -13
  10. CLASPLint-0.3.0/CLASPLint/runner.py +242 -0
  11. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint/variable_checker.py +43 -42
  12. CLASPLint-0.3.0/CLASPLint.egg-info/PKG-INFO +273 -0
  13. CLASPLint-0.3.0/LICENSE +688 -0
  14. CLASPLint-0.3.0/MANIFEST.in +3 -0
  15. CLASPLint-0.3.0/PKG-INFO +273 -0
  16. CLASPLint-0.3.0/README.md +245 -0
  17. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/pyproject.toml +2 -2
  18. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/setup.py +2 -2
  19. CLASPLint-0.2.0/CLASPLint/comment_checker.py +0 -356
  20. CLASPLint-0.2.0/CLASPLint/docstring_checker.py +0 -436
  21. CLASPLint-0.2.0/CLASPLint/runner.py +0 -212
  22. CLASPLint-0.2.0/CLASPLint.egg-info/PKG-INFO +0 -241
  23. CLASPLint-0.2.0/LICENSE +0 -16
  24. CLASPLint-0.2.0/MANIFEST.in +0 -1
  25. CLASPLint-0.2.0/PKG-INFO +0 -241
  26. CLASPLint-0.2.0/README.md +0 -213
  27. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint.egg-info/SOURCES.txt +0 -0
  28. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint.egg-info/dependency_links.txt +0 -0
  29. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint.egg-info/entry_points.txt +0 -0
  30. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint.egg-info/top_level.txt +0 -0
  31. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/CLASPLint.egg-info/zip-safe +0 -0
  32. {CLASPLint-0.2.0 → CLASPLint-0.3.0}/setup.cfg +0 -0
@@ -1,34 +1,35 @@
1
+ # -*- coding: utf-8 -*-
1
2
  """
2
3
  THIS FILE IS PART OF CLASPLINT BY MATT BELFAST BROWN
3
- CLASPLint.__init__ Package entry point and public API surface.
4
+ CLASPLint.__init__ -- Package entry point and public API surface.
4
5
 
5
6
  Exposes the runner and reporter modules as the primary public interface for
6
- programmatic use of the CLASP 3.0 / PEP 2606 static analysis engine.
7
+ programmatic use of the CLASP 3.1.1 / PEP 2606 static analysis engine.
7
8
 
8
9
  Author: Matt Belfast Brown
9
10
  Create Date: 2026-06-17
10
- Version Date: 2026-06-21
11
- Version: 0.2.0
11
+ Version Date: 2026-07-01
12
+ Version: 0.3.0
12
13
 
13
14
  THIS PROGRAM IS LICENSED UNDER GPL-3.0
14
15
  YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0 LICENSE.
15
16
 
16
17
  Copyright (C) 2026 Matt Belfast Brown
17
18
 
18
- This program is free software: you can redistribute it and/or modify
19
+ CLASPLint is free software: you can redistribute it and/or modify
19
20
  it under the terms of the GNU General Public License as published by
20
21
  the Free Software Foundation, version 3 of the License.
21
22
 
22
- This program is distributed in the hope that it will be useful,
23
+ CLASPLint is distributed in the hope that it will be useful,
23
24
  but WITHOUT ANY WARRANTY; without even the implied warranty
24
25
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
26
  GNU General Public License for more details.
26
27
 
27
28
  You should have received a copy of the GNU General Public License
28
- along with this program. If not, see <http://www.gnu.org/licenses/>.
29
+ along with CLASPLint. If not, see <https://www.gnu.org/licenses/>.
29
30
  """
30
31
 
31
32
  # Define the package version string.
32
- __version__ = "0.2.0"
33
+ __version__ = "0.3.0"
33
34
  # Expose the runner and reporter modules as the public API.
34
35
  __all__ = ["runner", "reporter"]
@@ -1,33 +1,35 @@
1
+ # -*- coding: utf-8 -*-
1
2
  """
2
3
  THIS FILE IS PART OF CLASPLINT BY MATT BELFAST BROWN
3
- CLASPLint.__main__ command-line entry point for the CLASP 3.0 static analysis tool.
4
+ CLASPLint.__main__ -- command-line entry point for the CLASP 3.1.1 static analysis tool.
4
5
 
5
6
  Author: Matt Belfast Brown
6
7
  Create Date: 2026-06-17
7
- Version Date: 2026-06-21
8
- Version: 0.2.0
8
+ Version Date: 2026-07-01
9
+ Version: 0.3.0
9
10
 
10
11
  THIS PROGRAM IS LICENSED UNDER GPL-3.0
11
12
  YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0 LICENSE.
12
13
 
13
14
  Copyright (C) 2026 Matt Belfast Brown
14
15
 
15
- This program is free software: you can redistribute it and/or modify
16
+ CLASPLint is free software: you can redistribute it and/or modify
16
17
  it under the terms of the GNU General Public License as published by
17
18
  the Free Software Foundation, version 3 of the License.
18
19
 
19
- This program is distributed in the hope that it will be useful,
20
+ CLASPLint is distributed in the hope that it will be useful,
20
21
  but WITHOUT ANY WARRANTY; without even the implied warranty
21
22
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22
23
  GNU General Public License for more details.
23
24
 
24
25
  You should have received a copy of the GNU General Public License
25
- along with this program. If not, see <http://www.gnu.org/licenses/>.
26
+ along with CLASPLint. If not, see <https://www.gnu.org/licenses/>.
26
27
  """
27
28
 
28
29
  import argparse
29
30
  import sys
30
31
  import os
32
+ from typing import Optional, Sequence
31
33
 
32
34
  from .runner import run
33
35
  from . import __version__
@@ -40,7 +42,7 @@ def _init_build_parser_function_() -> argparse.ArgumentParser:
40
42
  # Set the program name displayed in help text.
41
43
  prog="CLASPLint",
42
44
  # Provide a description of what the tool does.
43
- description="CLASP 3.0 / PEP 2606 static analysis tool. "
45
+ description="CLASP 3.1.1 / PEP 2606 static analysis tool. "
44
46
  # Continue the description across multiple lines for readability.
45
47
  "Checks variable, dict key, function, class naming "
46
48
  # Complete the tool description with comment and log conventions.
@@ -51,7 +53,7 @@ def _init_build_parser_function_() -> argparse.ArgumentParser:
51
53
  parser_result.add_argument(
52
54
  # Accept zero or more path strings as positional arguments.
53
55
  "paths", nargs="*", default=["."],
54
- # Provide the help text for the paths argument.
56
+ # Provide the help text for the paths' argument.
55
57
  help="Python files or directories to check (default: current directory).",
56
58
  # Close the first add_argument call.
57
59
  )
@@ -93,7 +95,7 @@ def _init_build_parser_function_() -> argparse.ArgumentParser:
93
95
  return parser_result
94
96
 
95
97
 
96
- def main(argv: list = None) -> int:
98
+ def main(argv: Optional[Sequence[str]] = None) -> int:
97
99
  """Execute the CLASPLint analysis and return an exit code (0 = clean, 1 = violations)."""
98
100
  # Build and parse command-line arguments.
99
101
  parser = _init_build_parser_function_()