Daniel Bedeleanu
ea49cd6e4a
- Create backend/services/image_storage.py with 4 core functions:
- sanitize_filename(): remove unsafe chars, limit to 255 chars, convert to lowercase
- get_unique_filename(): handle collisions with UUID suffix (format: {name}_{uuid8}_{variant}.jpg)
- ensure_image_directories(): create /images/ root and category subdirs on startup
- save_image(): save bytes to /images/{category}/{filename}, returns relative path
- Create comprehensive test suite (22 tests) covering all functionality
- Integrate ensure_image_directories() into FastAPI startup event
- Directory structure: /images/{category}/{filename}
- Collision handling: auto-suffix with UUID if filename exists
- All tests passing, pathlib.Path for safe operations
119 lines
3.5 KiB
Plaintext
119 lines
3.5 KiB
Plaintext
Metadata-Version: 2.4
|
|
Name: docstring_parser
|
|
Version: 0.18.0
|
|
Summary: Parse Python docstrings in reST, Google and Numpydoc format
|
|
Project-URL: homepage, https://github.com/rr-/docstring_parser
|
|
Project-URL: repository, https://github.com/rr-/docstring_parser
|
|
Project-URL: changelog, https://github.com/rr-/docstring_parser/blob/master/CHANGELOG.md
|
|
Author-email: Marcin Kurczewski <dash@wind.garden>
|
|
License: MIT
|
|
License-File: LICENSE.md
|
|
Classifier: Development Status :: 4 - Beta
|
|
Classifier: Environment :: Other Environment
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Natural Language :: English
|
|
Classifier: Operating System :: OS Independent
|
|
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: Programming Language :: Python :: 3.14
|
|
Classifier: Topic :: Documentation :: Sphinx
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Classifier: Topic :: Text Processing :: Markup
|
|
Requires-Python: >=3.8
|
|
Provides-Extra: dev
|
|
Requires-Dist: pre-commit>=2.16.0; (python_version >= '3.9') and extra == 'dev'
|
|
Requires-Dist: pydoctor>=25.4.0; extra == 'dev'
|
|
Requires-Dist: pytest; extra == 'dev'
|
|
Provides-Extra: docs
|
|
Requires-Dist: pydoctor>=25.4.0; extra == 'docs'
|
|
Provides-Extra: test
|
|
Requires-Dist: pytest; extra == 'test'
|
|
Description-Content-Type: text/markdown
|
|
|
|
docstring_parser
|
|
================
|
|
|
|
[](https://github.com/rr-/docstring_parser/actions/workflows/build.yml)
|
|
|
|
Parse Python docstrings. Currently support ReST, Google, Numpydoc-style and
|
|
Epydoc docstrings.
|
|
|
|
Example usage:
|
|
|
|
```python
|
|
>>> from docstring_parser import parse
|
|
>>>
|
|
>>>
|
|
>>> docstring = parse(
|
|
... '''
|
|
... Short description
|
|
...
|
|
... Long description spanning multiple lines
|
|
... - First line
|
|
... - Second line
|
|
... - Third line
|
|
...
|
|
... :param name: description 1
|
|
... :param int priority: description 2
|
|
... :param str sender: description 3
|
|
... :raises ValueError: if name is invalid
|
|
... ''')
|
|
>>>
|
|
>>> docstring.long_description
|
|
'Long description spanning multiple lines\n- First line\n- Second line\n- Third line'
|
|
>>> docstring.params[1].arg_name
|
|
'priority'
|
|
>>> docstring.raises[0].type_name
|
|
'ValueError'
|
|
```
|
|
|
|
Read [API Documentation](https://rr-.github.io/docstring_parser/).
|
|
|
|
# Installation
|
|
|
|
Installation using pip
|
|
|
|
```shell
|
|
pip install docstring_parser
|
|
|
|
# or if you want to install it in a virtual environment
|
|
|
|
python -m venv venv # create environment
|
|
source venv/bin/activate # activate environment
|
|
python -m pip install docstring_parser
|
|
```
|
|
|
|
Installation using conda
|
|
|
|
|
|
1. Download and install miniconda or anaconda
|
|
2. Install the package from the conda-forge channel via:
|
|
- `conda install -c conda-forge docstring_parser`
|
|
- or create a new conda environment via `conda create -n my-new-environment -c conda-forge docstring_parser`
|
|
|
|
|
|
# Contributing
|
|
|
|
To set up the project:
|
|
```sh
|
|
git clone https://github.com/rr-/docstring_parser.git
|
|
cd docstring_parser
|
|
|
|
python -m venv venv # create environment
|
|
source venv/bin/activate # activate environment
|
|
|
|
pip install -e ".[dev]" # install as editable
|
|
pre-commit install # make sure pre-commit is setup
|
|
```
|
|
|
|
To run tests:
|
|
```
|
|
source venv/bin/activate
|
|
pytest
|
|
```
|