google-docstring-parser 0.0.2__tar.gz → 0.0.6__tar.gz

{google_docstring_parser-0.0.2 → google_docstring_parser-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: google-docstring-parser
-Version: 0.0.2
+Version: 0.0.6
 Summary: A lightweight, efficient parser for Google-style Python docstrings that converts them into structured dictionaries.
 Author: Vladimir Iglovikov
 Maintainer: Vladimir Iglovikov
@@ -31,6 +31,7 @@ Requires-Dist: typing-extensions>=4.9; python_version < "3.10"
 Provides-Extra: dev
 Requires-Dist: pre-commit>=3.5; extra == "dev"
 Requires-Dist: pytest>=8.3.3; extra == "dev"
+Dynamic: license-file
 
 # Google Docstring Parser
 
@@ -75,6 +76,12 @@ Args:
 Example:
     >>> import albumentations as A
     >>> transform = A.ElasticTransform(alpha=1, sigma=50, p=0.5)
+
+References:
+    - Original paper: Simard, P. Y., et al. "Best practices for convolutional neural networks applied to visual document analysis." ICDAR 2003
+    - Implementation details: https://example.com/elastic-transform
+Returns:
+    dict[str, Any]: Some info here
 '''
 
 parsed = parse_google_docstring(docstring)
@@ -97,7 +104,22 @@ Output:
             'description': 'Standard deviation of the Gaussian filter used to smooth the displacement\nfields. Higher values result in smoother, more global distortions. Default: 50.0'
         }
     ],
-    'Example': '>>> import albumentations as A\n>>> transform = A.ElasticTransform(alpha=1, sigma=50, p=0.5)'
+    'Example': '>>> import albumentations as A\n>>> transform = A.ElasticTransform(alpha=1, sigma=50, p=0.5)',
+    'References': [
+        {
+            'description': 'Original paper',
+            'source': 'Simard, P. Y., et al. "Best practices for convolutional neural networks applied to visual document analysis." ICDAR 2003'
+        },
+        {
+            'description': 'Implementation details',
+            'source': 'https://example.com/elastic-transform'
+        }
+    ],
+    'Returns':
+        {
+            "type": "dict[str, Any]",
+            "description": "Some info here"
+        }
 }
 ```
 
@@ -107,7 +129,30 @@ Output:
 - Extracts parameter names, types, and descriptions
 - Preserves other sections like Examples, Notes, etc.
 - Handles multi-line descriptions and indentation properly
+- Properly parses and validates References sections with special handling for URLs
+
+### References
 
+The parser can handle reference sections in Google-style docstrings. References can be formatted in two ways:
+
+1. Single reference format:
+```python
+"""
+Reference:
+    Paper title: https://example.com/paper
+"""
+```
+
+2. Multiple references format (requires leading dashes):
+```python
+"""
+References:
+    - First paper: https://example.com/paper1
+    - Second paper: https://example.com/paper2
+"""
+```
+
+Each reference is parsed into a dictionary with `description` and `source` keys. URLs in the source are properly handled, ensuring colons in URLs are not confused with the separator colon.
 
 ## Pre-commit Hook
 
@@ -135,14 +180,7 @@ Add a `[tool.docstring_checker]` section to your pyproject.toml:
 [tool.docstring_checker]
 paths = ["src", "tests"]                     # Directories or files to scan
 require_param_types = true                   # Require parameter types in docstrings
+check_references = true                      # Check references for proper format
 exclude_files = ["conftest.py", "__init__.py"] # Files to exclude from checks
 verbose = false                              # Enable verbose output
 ```
-
-This approach has several advantages:
-- Keeps all your project configuration in one place
-- Follows modern Python tooling conventions
-- Makes it easier to maintain and update configuration
-- Provides better IDE support and documentation
-
-For more details, see the [tools README](tools/README.md).

{google_docstring_parser-0.0.2 → google_docstring_parser-0.0.6}/README.md

@@ -41,6 +41,12 @@ Args:
 Example:
     >>> import albumentations as A
     >>> transform = A.ElasticTransform(alpha=1, sigma=50, p=0.5)
+
+References:
+    - Original paper: Simard, P. Y., et al. "Best practices for convolutional neural networks applied to visual document analysis." ICDAR 2003
+    - Implementation details: https://example.com/elastic-transform
+Returns:
+    dict[str, Any]: Some info here
 '''
 
 parsed = parse_google_docstring(docstring)
@@ -63,7 +69,22 @@ Output:
             'description': 'Standard deviation of the Gaussian filter used to smooth the displacement\nfields. Higher values result in smoother, more global distortions. Default: 50.0'
         }
     ],
-    'Example': '>>> import albumentations as A\n>>> transform = A.ElasticTransform(alpha=1, sigma=50, p=0.5)'
+    'Example': '>>> import albumentations as A\n>>> transform = A.ElasticTransform(alpha=1, sigma=50, p=0.5)',
+    'References': [
+        {
+            'description': 'Original paper',
+            'source': 'Simard, P. Y., et al. "Best practices for convolutional neural networks applied to visual document analysis." ICDAR 2003'
+        },
+        {
+            'description': 'Implementation details',
+            'source': 'https://example.com/elastic-transform'
+        }
+    ],
+    'Returns':
+        {
+            "type": "dict[str, Any]",
+            "description": "Some info here"
+        }
 }
 ```
 
@@ -73,7 +94,30 @@ Output:
 - Extracts parameter names, types, and descriptions
 - Preserves other sections like Examples, Notes, etc.
 - Handles multi-line descriptions and indentation properly
+- Properly parses and validates References sections with special handling for URLs
+
+### References
 
+The parser can handle reference sections in Google-style docstrings. References can be formatted in two ways:
+
+1. Single reference format:
+```python
+"""
+Reference:
+    Paper title: https://example.com/paper
+"""
+```
+
+2. Multiple references format (requires leading dashes):
+```python
+"""
+References:
+    - First paper: https://example.com/paper1
+    - Second paper: https://example.com/paper2
+"""
+```
+
+Each reference is parsed into a dictionary with `description` and `source` keys. URLs in the source are properly handled, ensuring colons in URLs are not confused with the separator colon.
 
 ## Pre-commit Hook
 
@@ -101,14 +145,7 @@ Add a `[tool.docstring_checker]` section to your pyproject.toml:
 [tool.docstring_checker]
 paths = ["src", "tests"]                     # Directories or files to scan
 require_param_types = true                   # Require parameter types in docstrings
+check_references = true                      # Check references for proper format
 exclude_files = ["conftest.py", "__init__.py"] # Files to exclude from checks
 verbose = false                              # Enable verbose output
 ```
-
-This approach has several advantages:
-- Keeps all your project configuration in one place
-- Follows modern Python tooling conventions
-- Makes it easier to maintain and update configuration
-- Provides better IDE support and documentation
-
-For more details, see the [tools README](tools/README.md).

google_docstring_parser-0.0.6/google_docstring_parser/__init__.py

@@ -0,0 +1,10 @@
+"""Google Docstring Parser package.
+
+A lightweight, efficient parser for Google-style Python docstrings that converts them into structured dictionaries.
+
+"""
+
+from google_docstring_parser.google_docstring_parser import ReferenceFormatError, parse_google_docstring
+from google_docstring_parser.type_validation import InvalidTypeAnnotationError
+
+__all__ = ["InvalidTypeAnnotationError", "ReferenceFormatError", "parse_google_docstring"]