docstring-to-text 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

docstring_to_text/___package_meta.py

@@ -0,0 +1,111 @@
+# encoding: utf-8
+
+# It should be a hard-coded string, as close to the beginning of file as possible,
+# for Hatchling build tools to properly parse it:
+VERSION = "1.0.3"
+
+
+# =============================================================
+# Parsing it into a tuple, more suitable for version comparison
+
+
+import typing as _t
+
+import re as _re
+
+_re_separate = _re.compile(
+	# r'^'  # not necessary with `re.match()`
+	r'([a-zA-Z_0-9\s]*)'  # valid version-seg characters - greedy
+	r'[^a-zA-Z_0-9\s]+'  # anything else
+	r'(.*?)'  # the remainder of the string, possibly with a mix of both - lazy
+	r'$'  # must match the entire string
+).match
+
+
+def _raw_version_parts_gen(ver_str: str) -> _t.Generator[str, _t.Any, None]:
+	"""Splits version string into parts.
+
+	Parts contain only alphanumeric characters, underscores and spaces/tabs.
+	Anything else considered a separator.
+	Integer sub-parts aren't extracted yet.
+	"""
+	assert ver_str and isinstance(ver_str, str)
+	remainder: str = ver_str.strip()
+
+	match = _re_separate(remainder)
+	while match:
+		groups = [
+			x.strip() if x else ''
+			for x in match.groups()
+		]
+		while len(groups) < 2:
+			groups.append('')
+		part, remainder = groups[:2]
+
+		# to replace any whitespace sequences to single spaces:
+		part = ' '.join(part.split())
+		if part:
+			yield part
+
+		match = _re_separate(remainder)
+
+	if remainder:
+		yield remainder
+
+
+_re_int_extractor = _re.compile(
+	r'([^0-9]*)'
+	r'([0-9]+)'
+	r'([^0-9].*?)?'
+	r'$'
+).match
+
+
+def _part_to_final_segs_gen(str_part: str) -> _t.Generator[_t.Union[int, str], _t.Any, None]:
+	"""Given one part, separates it into actual version segments."""
+	assert str_part and isinstance(str_part, str)
+	remainder: str = str_part
+
+	while remainder:
+		remainder = remainder.strip().strip('_')
+		match = _re_int_extractor(remainder)
+		if not match:
+			assert not any(x in remainder for x in '0123456789'), (
+				f"Internal error: last version-remainder for {str_part!r} part still contains digits: {remainder!r}"
+			)
+			break
+
+		groups = [
+			x.strip().strip('_') if x else ''
+			for x in match.groups()
+		]
+		while len(groups) < 3:
+			groups.append('')
+		text_prefix, int_str, remainder = groups[:3]
+
+		if text_prefix:
+			yield text_prefix
+
+		yield int(int_str)
+
+	if remainder:
+		yield remainder
+
+
+def _version_parts_gen(ver_str: str) -> _t.Generator[_t.Union[int, str], _t.Any, None]:
+	"""Parse version string into parts, with ints.
+
+	- '0.1.2' -> (0, 1, 2)
+	- '0.1.2rc' -> (0, 1, 2, 'rc')
+	- '0.1.2rc0123' -> (0, 1, 2, 'rc', 123)
+	- '0.1.2-alpha1' -> (0, 1, 2, 'alpha', 1)
+	- '0-1-2-beta-1' -> (0, 1, 2, 'beta', 1)  # though, non-compliant with semantic versioning
+	- '0.1.2.beta.2' -> (0, 1, 2, 'beta', 2)
+	"""
+	for str_part in _raw_version_parts_gen(ver_str):
+		for seg in _part_to_final_segs_gen(str_part):
+			yield seg
+
+
+# For actual python code to compare:
+VERSION_TUPLE: _t.Tuple[_t.Union[int, str], ...] = tuple(_version_parts_gen(VERSION))

docstring_to_text/__init__.py

@@ -3,13 +3,17 @@
 A simple pip package converting docstrings into clean text (proper paragraphs and indents).
 """
 
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
 import typing as _t
 
 from inspect import cleandoc, getdoc
 import re as _re
 
-from .__package_meta import VERSION
-from .__package_meta import VERSION as __version__
+from .___package_meta import VERSION
+from .___package_meta import VERSION as __version__
 
 # TODO:
 # - lists

{docstring_to_text-1.0.1.dist-info → docstring_to_text-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-to-text
-Version: 1.0.1
+Version: 1.0.3
 Summary: A simple pip package converting docstrings into clean text (proper paragraphs and indents)
 Project-URL: Source Code, https://github.com/Lex-DRL/Py-docstring-to-text
 Project-URL: Issues, https://github.com/Lex-DRL/Py-docstring-to-text/issues
@@ -11,17 +11,34 @@ Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.7
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
 Description-Content-Type: text/markdown
 
+<div align="center">
+  
 # docstring-to-text
 
+[![PyPI][pypi-shield]][pypi-url]
+[![GitHub Release][github-release-shield]][github-release-url]
+[![Test status][github-tests-shield]][github-tests-url]
+
+[pypi-shield]: https://img.shields.io/pypi/v/docstring-to-text?logo=pypi
+[pypi-url]: https://pypi.org/p/docstring-to-text
+[github-tests-shield]: https://github.com/Lex-DRL/Py-docstring-to-text/actions/workflows/test.yml/badge.svg?branch=main
+[github-tests-url]: https://github.com/Lex-DRL/Py-docstring-to-text/actions/workflows/test.yml?query=branch%3Amain
+[github-release-shield]: https://img.shields.io/github/v/release/Lex-DRL/Py-docstring-to-text?logo=github
+[github-release-url]: https://github.com/Lex-DRL/Py-docstring-to-text/releases/latest
+</div>
+
 A simple pip package converting docstrings into clean text (proper paragraphs and indents).
 
 For example, here's a class docstring:
 ```python
 class MyClass:
   """
-  Here's a class.
+  This is a class docstring.
   
   
   It has sphinx-like paragraphs, which can
@@ -60,7 +77,7 @@ clean_text = format_object_docstring(MyClass)
 
 Then, the resulting string would be:
 ```text
-Here's a class.
+This is a class docstring.
 
 It has sphinx-like paragraphs, which can span multiple lines. Any modern IDE would display them as a single line, that wraps the given width.
 You can't just remove all the new lines in the entire string, because you want to preserve paragraphs themselves.

docstring_to_text-1.0.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+docstring_to_text/___package_meta.py,sha256=3rGnvbA_I52gm_UFR_7Pl8TerSA-eC5OHm5LzS63Ics,2921
+docstring_to_text/__init__.py,sha256=BDcfU7T33sckZzEZFZn2GPezDtb9fkv1A2uo2mPYZas,5000
+docstring_to_text-1.0.3.dist-info/METADATA,sha256=XrbJhSHaYyPAtV6ZY8wS-XIh-C137GT6HyM0w7bz1u4,3156
+docstring_to_text-1.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+docstring_to_text-1.0.3.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
+docstring_to_text-1.0.3.dist-info/RECORD,,

docstring_to_text/__package_meta.py

@@ -1,3 +0,0 @@
-# encoding: utf-8
-
-VERSION = "1.0.1"

docstring_to_text-1.0.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-docstring_to_text/__init__.py,sha256=tkoGbf8ZJv70Nf2osZSn4DoHwSZKK2nvRREpvaVHank,4798
-docstring_to_text/__package_meta.py,sha256=AkzYkNZ1txGq77pbjfo4hVXLrvLpeJOHmfoOc0AZgiY,37
-docstring_to_text-1.0.1.dist-info/METADATA,sha256=JrCksCfeZ8SLMwzZ9GlM-olZCQWLfHY41q6JKHUp5ME,2297
-docstring_to_text-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-docstring_to_text-1.0.1.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
-docstring_to_text-1.0.1.dist-info/RECORD,,