google-docstring-parser 0.0.7__tar.gz → 0.0.9__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 (16) hide show
  1. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/PKG-INFO +3 -4
  2. google_docstring_parser-0.0.9/google_docstring_parser/py.typed +0 -0
  3. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/PKG-INFO +3 -4
  4. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/SOURCES.txt +1 -0
  5. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/requires.txt +0 -3
  6. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/pyproject.toml +7 -8
  7. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/tools/check_docstrings.py +9 -1
  8. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/LICENSE +0 -0
  9. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/README.md +0 -0
  10. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser/__init__.py +0 -0
  11. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser/google_docstring_parser.py +0 -0
  12. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser/type_validation.py +0 -0
  13. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/dependency_links.txt +0 -0
  14. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/top_level.txt +0 -0
  15. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/setup.cfg +0 -0
  16. {google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/tools/__init__.py +0 -0
{google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: google-docstring-parser
3
- Version: 0.0.7
3
+ Version: 0.0.9
4
4
  Summary: A lightweight, efficient parser for Google-style Python docstrings that converts them into structured dictionaries.
5
5
  Author: Vladimir Iglovikov
6
6
  Maintainer: Vladimir Iglovikov
@@ -13,21 +13,20 @@ Classifier: License :: Other/Proprietary License
13
13
  Classifier: Operating System :: OS Independent
14
14
  Classifier: Programming Language :: Python
15
15
  Classifier: Programming Language :: Python :: 3 :: Only
16
- Classifier: Programming Language :: Python :: 3.9
17
16
  Classifier: Programming Language :: Python :: 3.10
18
17
  Classifier: Programming Language :: Python :: 3.11
19
18
  Classifier: Programming Language :: Python :: 3.12
20
19
  Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
21
  Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
22
22
  Classifier: Topic :: Software Development :: Documentation
23
23
  Classifier: Topic :: Software Development :: Libraries
24
24
  Classifier: Topic :: Software Development :: Libraries :: Python Modules
25
25
  Classifier: Typing :: Typed
26
- Requires-Python: >=3.9
26
+ Requires-Python: >=3.10
27
27
  Description-Content-Type: text/markdown
28
28
  License-File: LICENSE
29
29
  Requires-Dist: docstring-parser>=0.16
30
- Requires-Dist: typing-extensions>=4.9; python_version < "3.10"
31
30
  Provides-Extra: dev
32
31
  Requires-Dist: pre-commit>=3.5; extra == "dev"
33
32
  Requires-Dist: pytest>=8.3.3; extra == "dev"
{google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: google-docstring-parser
3
- Version: 0.0.7
3
+ Version: 0.0.9
4
4
  Summary: A lightweight, efficient parser for Google-style Python docstrings that converts them into structured dictionaries.
5
5
  Author: Vladimir Iglovikov
6
6
  Maintainer: Vladimir Iglovikov
@@ -13,21 +13,20 @@ Classifier: License :: Other/Proprietary License
13
13
  Classifier: Operating System :: OS Independent
14
14
  Classifier: Programming Language :: Python
15
15
  Classifier: Programming Language :: Python :: 3 :: Only
16
- Classifier: Programming Language :: Python :: 3.9
17
16
  Classifier: Programming Language :: Python :: 3.10
18
17
  Classifier: Programming Language :: Python :: 3.11
19
18
  Classifier: Programming Language :: Python :: 3.12
20
19
  Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
21
  Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
22
22
  Classifier: Topic :: Software Development :: Documentation
23
23
  Classifier: Topic :: Software Development :: Libraries
24
24
  Classifier: Topic :: Software Development :: Libraries :: Python Modules
25
25
  Classifier: Typing :: Typed
26
- Requires-Python: >=3.9
26
+ Requires-Python: >=3.10
27
27
  Description-Content-Type: text/markdown
28
28
  License-File: LICENSE
29
29
  Requires-Dist: docstring-parser>=0.16
30
- Requires-Dist: typing-extensions>=4.9; python_version < "3.10"
31
30
  Provides-Extra: dev
32
31
  Requires-Dist: pre-commit>=3.5; extra == "dev"
33
32
  Requires-Dist: pytest>=8.3.3; extra == "dev"
{google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/SOURCES.txt RENAMED
@@ -3,6 +3,7 @@ README.md
3
3
  pyproject.toml
4
4
  google_docstring_parser/__init__.py
5
5
  google_docstring_parser/google_docstring_parser.py
6
+ google_docstring_parser/py.typed
6
7
  google_docstring_parser/type_validation.py
7
8
  google_docstring_parser.egg-info/PKG-INFO
8
9
  google_docstring_parser.egg-info/SOURCES.txt
{google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/google_docstring_parser.egg-info/requires.txt RENAMED
@@ -1,8 +1,5 @@
1
1
  docstring-parser>=0.16
2
2
 
3
- [:python_version < "3.10"]
4
- typing-extensions>=4.9
5
-
6
3
  [dev]
7
4
  pre-commit>=3.5
8
5
  pytest>=8.3.3
{google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/pyproject.toml RENAMED
@@ -5,7 +5,7 @@ requires = [ "setuptools>=45", "wheel" ]
5
5
 
6
6
  [project]
7
7
  name = "google-docstring-parser"
8
- version = "0.0.7"
8
+ version = "0.0.9"
9
9
 
10
10
  description = "A lightweight, efficient parser for Google-style Python docstrings that converts them into structured dictionaries."
11
11
  readme = "README.md"
@@ -14,7 +14,7 @@ license = { text = "Custom License - See LICENSE file for details" }
14
14
  maintainers = [ { name = "Vladimir Iglovikov" } ]
15
15
 
16
16
  authors = [ { name = "Vladimir Iglovikov" } ]
17
- requires-python = ">=3.9"
17
+ requires-python = ">=3.10"
18
18
 
19
19
  classifiers = [
20
20
  "Development Status :: 5 - Production/Stable",
@@ -24,11 +24,11 @@ classifiers = [
24
24
  "Operating System :: OS Independent",
25
25
  "Programming Language :: Python",
26
26
  "Programming Language :: Python :: 3 :: Only",
27
- "Programming Language :: Python :: 3.9",
28
27
  "Programming Language :: Python :: 3.10",
29
28
  "Programming Language :: Python :: 3.11",
30
29
  "Programming Language :: Python :: 3.12",
31
30
  "Programming Language :: Python :: 3.13",
31
+ "Programming Language :: Python :: 3.14",
32
32
  "Topic :: Scientific/Engineering :: Artificial Intelligence",
33
33
  "Topic :: Software Development :: Documentation",
34
34
  "Topic :: Software Development :: Libraries",
@@ -38,7 +38,6 @@ classifiers = [
38
38
 
39
39
  dependencies = [
40
40
  "docstring-parser>=0.16",
41
- "typing-extensions>=4.9; python_version<'3.10'",
42
41
  ]
43
42
 
44
43
  optional-dependencies.dev = [
@@ -50,19 +49,19 @@ optional-dependencies.dev = [
50
49
  packages = [ "google_docstring_parser", "tools" ]
51
50
 
52
51
  [tool.setuptools.package-data]
53
- google_docstring_parser = [ "*.md" ]
52
+ google_docstring_parser = [ "*.md", "py.typed" ]
54
53
 
55
54
  [tool.setuptools.exclude-package-data]
56
55
  "*" = [ "tests*" ]
57
56
 
58
57
  [tool.ruff]
59
58
  # Exclude a variety of commonly ignored directories.
60
- target-version = "py39"
59
+ target-version = "py310"
61
60
 
62
61
  line-length = 120
63
62
  indent-width = 4
64
63
 
65
- # Assume Python 3.9
64
+ # Assume Python 3.10
66
65
  exclude = [
67
66
  ".bzr",
68
67
  ".cursor",
@@ -130,7 +129,7 @@ lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
130
129
  lint.pydocstyle.convention = "google"
131
130
 
132
131
  [tool.mypy]
133
- python_version = "3.9"
132
+ python_version = "3.10"
134
133
  ignore_missing_imports = true
135
134
  follow_imports = "silent"
136
135
  warn_redundant_casts = true
{google_docstring_parser-0.0.7 → google_docstring_parser-0.0.9}/tools/check_docstrings.py RENAMED
@@ -22,7 +22,7 @@ from google_docstring_parser.google_docstring_parser import (
22
22
 
23
23
  # Default configuration
24
24
  DEFAULT_CONFIG = {
25
- "paths": ["."],
25
+ "paths": [], # Empty by default, so no directories are scanned unless explicitly specified
26
26
  "require_param_types": False,
27
27
  "check_references": True,
28
28
  "exclude_files": [],
@@ -703,6 +703,14 @@ def main() -> None:
703
703
  print(f" Check references: {check_references}")
704
704
  print(f" Exclude files: {exclude_files}")
705
705
 
706
+ # Check if paths is empty
707
+ if not paths:
708
+ print(
709
+ "No paths specified for checking. Please specify paths as command line "
710
+ "arguments or configure them in pyproject.toml under [tool.docstring_checker] section.",
711
+ )
712
+ sys.exit(0)
713
+
706
714
  if all_errors := _process_paths(
707
715
  paths,
708
716
  exclude_files,