forked from pool/python-docformatter
Steve Kowalik
487f5a9eaa
* Features
+ fix: not recognizing `yield` as a sphinx field name
+ feat: support epytext style
+ feat: use tomllib for Python 3.11+
+ feat: wrap Sphinx style long parameter descriptions
+ feat: add option for user to provide list of words not to capitalize
+ Support python 3.11
* Bug Fixes
+ fix: summary with back ticks and sphinx field names with periods
+ fix: removing newline between Sphinx field lists
+ fix: wrapping issues with reST directives, quoted URLs, and Sphinx
field lists
+ fix: improper wrapping of short anonymous hyperlnks
+ fix: removing blank line after import section
+ fix: IndexError when only URL in long description
+ fix: removing newline after shebang
+ fix: not capitalizing first word when summary ends in period
+ fix: adding newlines around wrapped URL
+ fix: adding blank line in summary with symbol
+ fix: remove blank lines after line beginning with 'def'
+ fix: update URL handling functions
- Switch to autosetup and pyproject macros.
- No more greedy globs in %files.
- Add patches:
* remove-mock.patch
+ Do not use external mock module
* support-python-312.patch
+ Support Python 3.12+ changes
* do-not-require-venv.patch
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-docformatter?expand=0&rev=19
102 lines
3.4 KiB
RPMSpec
102 lines
3.4 KiB
RPMSpec
#
|
|
# spec file for package python-docformatter
|
|
#
|
|
# Copyright (c) 2024 SUSE LLC
|
|
#
|
|
# All modifications and additions to the file contributed by third parties
|
|
# remain the property of their copyright owners, unless otherwise agreed
|
|
# upon. The license for this file, and modifications and additions to the
|
|
# file, is the same license as for the pristine package itself (unless the
|
|
# license for the pristine package is not an Open Source License, in which
|
|
# case the license is the MIT License). An "Open Source License" is a
|
|
# license that conforms to the Open Source Definition (Version 1.9)
|
|
# published by the Open Source Initiative.
|
|
|
|
# Please submit bugfixes or comments via https://bugs.opensuse.org/
|
|
#
|
|
|
|
|
|
Name: python-docformatter
|
|
Version: 1.7.5
|
|
Release: 0
|
|
Summary: Utility to re-format docstrings per PEP 257
|
|
License: MIT
|
|
URL: https://github.com/myint/docformatter
|
|
Source: https://github.com/PyCQA/docformatter/archive/refs/tags/v%{version}.tar.gz#/docformatter-%{version}.tar.gz
|
|
# PATCH-FIX-UPSTREAM gh#PyCQA/docformatter#280
|
|
Patch0: remove-mock.patch
|
|
# PATCH-FIX-UPSTREAM gh#PyCQA/docformatter#296
|
|
Patch1: support-python-312.patch
|
|
# PATCH-FIX-OPENSUSE Do not require virtualenvs to run the tests
|
|
Patch2: do-not-require-venv.patch
|
|
BuildRequires: %{python_module base >= 3.7}
|
|
BuildRequires: %{python_module pip}
|
|
BuildRequires: %{python_module poetry-core}
|
|
BuildRequires: fdupes
|
|
BuildRequires: python-rpm-macros
|
|
Requires: python-charset-normalizer
|
|
Requires: python-untokenize
|
|
Requires(post): update-alternatives
|
|
Requires(postun): update-alternatives
|
|
BuildArch: noarch
|
|
# SECTION test requirements
|
|
BuildRequires: %{python_module pytest}
|
|
BuildRequires: %{python_module charset-normalizer >= 3.0}
|
|
BuildRequires: %{python_module untokenize}
|
|
# /SECTION
|
|
%python_subpackages
|
|
|
|
%description
|
|
Docformatter currently automatically formats docstrings to follow a
|
|
subset of the PEP 257 conventions. Below are the relevant items quoted
|
|
from PEP 257.
|
|
|
|
- For consistency, always use triple double quotes around docstrings.
|
|
- Triple quotes are used even though the string fits on one line.
|
|
- Multi-line docstrings consist of a summary line just like a one-line
|
|
docstring, followed by a blank line, followed by a more elaborate
|
|
description.
|
|
- The BDFL recommends inserting a blank line between the last paragraph
|
|
in a multi-line docstring and its closing quotes, placing the closing
|
|
quotes on a line by themselves.
|
|
|
|
docformatter also handles some of the PEP 8 conventions.
|
|
|
|
- Don't write string literals that rely on significant trailing
|
|
whitespace. Such trailing whitespace is visually indistinguishable
|
|
and some editors (or more recently, reindent.py) will trim them.
|
|
|
|
%prep
|
|
%autosetup -p1 -n docformatter-%{version}
|
|
sed -i -e '/^#!\//, 1d' src/docformatter/*.py
|
|
chmod -x src/docformatter/__main__.py
|
|
|
|
%build
|
|
%pyproject_wheel
|
|
|
|
%install
|
|
%pyproject_install
|
|
# Do not install LICENSE
|
|
%python_expand rm %{buildroot}%{$python_sitelib}/LICENSE
|
|
%python_clone -a %{buildroot}%{_bindir}/docformatter
|
|
%python_expand %fdupes %{buildroot}%{$python_sitelib}
|
|
|
|
%check
|
|
export BUILDROOT=%{buildroot}
|
|
%pytest
|
|
|
|
%post
|
|
%python_install_alternative docformatter
|
|
|
|
%postun
|
|
%python_uninstall_alternative docformatter
|
|
|
|
%files %{python_files}
|
|
%license LICENSE
|
|
%doc AUTHORS.rst README.rst
|
|
%python_alternative %{_bindir}/docformatter
|
|
%{python_sitelib}/docformatter
|
|
%{python_sitelib}/docformatter-%{version}.dist-info
|
|
|
|
%changelog
|