refactor: __init__.py -> snippets.py

Author: SilverRainZ

src/sphinxnotes/snippet/cache.py

@@ -9,7 +9,7 @@
 from typing import List, Tuple, Dict, Optional
 from dataclasses import dataclass
 
-from . import Snippet
+from .snippets import Snippet
 from .utils.pdict import PDict
 
 

src/sphinxnotes/snippet/cli.py

@@ -14,10 +14,10 @@
 from textwrap import dedent
 from shutil import get_terminal_size
 import posixpath
+from importlib.metadata import version
 
 from xdg.BaseDirectory import xdg_config_home
 
-from . import __version__
 from .config import Config
 from .cache import Cache
 from .table import tablify, COLUMNS
@@ -60,7 +60,10 @@ def main(argv: List[str] = sys.argv[1:]):
                                        * (any)               wildcard for any snippet"""),
     )
     parser.add_argument(
-        '-v', '--version', action='version', version='%(prog)s ' + __version__
+        '-v',
+        '--version',
+        action='version',
+        version='%(prog)s ' + version('sphinxnotes.any'),
     )
     parser.add_argument(
         '-c', '--config', default=DEFAULT_CONFIG_FILE, help='path to configuration file'

src/sphinxnotes/snippet/ext.py

@@ -26,7 +26,7 @@
     from collections.abc import Iterator
 
 from .config import Config
-from . import Snippet, WithTitle, Document, Section
+from .snippets import Snippet, WithTitle, Document, Section
 from .picker import pick
 from .cache import Cache, Item
 from .keyword import Extractor

src/sphinxnotes/snippet/picker.py

@@ -15,7 +15,7 @@
 
 from sphinx.util import logging
 
-from . import Snippet, Section, Document
+from .snippets import Snippet, Section, Document
 
 if TYPE_CHECKING:
     from sphinx.application import Sphinx

src/sphinxnotes/snippet/__init__.py renamed to src/sphinxnotes/snippet/snippets.py

@@ -1,8 +1,10 @@
 """
-sphinxnotes.snippet
-~~~~~~~~~~~~~~~~~~~
+sphinxnotes.snippet.snippets
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-:copyright: Copyright 2020 Shengyu Zhang
+Definitions of various snippets.
+
+:copyright: Copyright 2024 Shengyu Zhang
 :license: BSD, see LICENSE for details.
 """
 
@@ -15,14 +17,13 @@
 if TYPE_CHECKING:
     from sphinx.environment import BuildEnvironment
 
-__version__ = '1.1.1'
-
 
 class Snippet(object):
     """
-    Snippet is base class of reStructuredText snippet.
+    Snippet is structured fragments extracted from a single Sphinx document
+    (can also be said to be a reStructuredText file).
 
-    :param nodes: Document nodes that make up this snippet
+    :param nodes: nodes of doctree that make up this snippet.
     """
 
     #: docname where the snippet is located, can be referenced by