omdev 0.0.0.dev282__tar.gz → 0.0.0.dev283__tar.gz

{omdev-0.0.0.dev282/omdev.egg-info → omdev-0.0.0.dev283}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: omdev
-Version: 0.0.0.dev282
+Version: 0.0.0.dev283
 Summary: omdev
 Author: wrmsr
 License: BSD-3-Clause
@@ -12,7 +12,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Operating System :: POSIX
 Requires-Python: >=3.12
 License-File: LICENSE
-Requires-Dist: omlish==0.0.0.dev282
+Requires-Dist: omlish==0.0.0.dev283
 Provides-Extra: all
 Requires-Dist: black~=25.1; extra == "all"
 Requires-Dist: pycparser~=2.22; extra == "all"

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/.manifests.json

@@ -11,11 +11,23 @@
       }
     }
   },
+  {
+    "module": ".attrdocs",
+    "attr": "_CLI_MODULE",
+    "file": "omdev/attrdocs.py",
+    "line": 146,
+    "value": {
+      "$.cli.types.CliModule": {
+        "cmd_name": "py/attrdocs",
+        "mod_name": "omdev.attrdocs"
+      }
+    }
+  },
   {
     "module": ".bracepy",
     "attr": "_CLI_MODULE",
     "file": "omdev/bracepy.py",
-    "line": 88,
+    "line": 94,
     "value": {
       "$.cli.types.CliModule": {
         "cmd_name": "bracepy",
@@ -51,7 +63,7 @@
     "module": ".classdot",
     "attr": "_CLI_MODULE",
     "file": "omdev/classdot.py",
-    "line": 62,
+    "line": 65,
     "value": {
       "$.cli.types.CliModule": {
         "cmd_name": "py/classdot",
@@ -75,7 +87,7 @@
     "module": ".findimports",
     "attr": "_CLI_MODULE",
     "file": "omdev/findimports.py",
-    "line": 81,
+    "line": 87,
     "value": {
       "$.cli.types.CliModule": {
         "cmd_name": "py/findimports",
@@ -87,7 +99,7 @@
     "module": ".imgur",
     "attr": "_FOO_CLI_MODULE",
     "file": "omdev/imgur.py",
-    "line": 130,
+    "line": 133,
     "value": {
       "$.cli.types.CliModule": {
         "cmd_name": "imgur",

omdev-0.0.0.dev283/omdev/attrdocs.py

@@ -0,0 +1,177 @@
+# ruff: noqa: N802
+import ast
+import dataclasses as dc
+import inspect
+import typing as ta
+
+from omlish import check
+from omlish import lang
+
+from .tokens import all as tks
+
+
+##
+
+
+@dc.dataclass(frozen=True)
+class AttrDoc:
+    docstring: str | None = None
+    trailing_comment: str | None = None
+    preceding_comment: str | None = None
+
+    __repr__ = lang.AttrRepr.of(
+        'docstring',
+        'trailing_comment',
+        'preceding_comment',
+        value_filter=bool,
+    )
+
+
+_EMPTY_ATTR_DOC = AttrDoc()
+
+
+##
+
+
+class _AttrDocAstVisitor(ast.NodeVisitor):
+    def __init__(
+            self,
+            *,
+            tok_lines: ta.Sequence[tks.Tokens] | None = None,
+    ) -> None:
+        super().__init__()
+
+        self._tok_lines = tok_lines
+
+        self._attr_docs: dict[str, AttrDoc] = {}
+        self._target: str | None = None
+        self._prev_node_type: type[ast.AST] | None = None
+
+    @property
+    def attr_docs(self) -> ta.Mapping[str, AttrDoc]:
+        return self._attr_docs
+
+    #
+
+    def visit(self, node: ast.AST) -> ta.Any:
+        if isinstance(node, (ast.AsyncFunctionDef, ast.FunctionDef)):
+            self._prev_node_type = None
+            return None
+        node_result = super().visit(node)
+        self._prev_node_type = type(node)
+        return node_result
+
+    #
+
+    @staticmethod
+    def _comment_tok_src(tok: tks.Token) -> str:
+        check.state(tok.name == 'COMMENT')
+        tc = tok.src
+        check.state(tc[0] == '#')
+        return tc[1:].lstrip()
+
+    def _set_target(self, node: ast.Name) -> None:
+        self._target = node.id
+
+        ad = _EMPTY_ATTR_DOC
+
+        if self._tok_lines is not None:
+            line = self._tok_lines[node.lineno - 1]
+            for t in reversed(line):
+                if t.name not in tks.WS_NAMES:
+                    break
+                if t.name == 'COMMENT':
+                    ad = dc.replace(ad, trailing_comment=self._comment_tok_src(t))
+                    break
+
+            pll: list[str] = []
+            pln = node.lineno - 1
+            while pln > 0:
+                line = self._tok_lines[pln - 1]
+                no_ws_line = list(tks.ignore_ws(line, keep={'COMMENT'}))
+                if not no_ws_line or no_ws_line[0].name != 'COMMENT':  # noqa
+                    break
+                pll.append(self._comment_tok_src(no_ws_line[0]))
+                pln -= 1
+            if pll:
+                ad = dc.replace(ad, preceding_comment='\n'.join(reversed(pll)))
+
+        if ad is not _EMPTY_ATTR_DOC:
+            self._attr_docs[node.id] = ad
+
+    def visit_AnnAssign(self, node: ast.AnnAssign) -> ta.Any:
+        if isinstance(target := node.target, ast.Name):
+            self._set_target(target)
+
+    def visit_Assign(self, node: ast.Assign) -> ta.Any:
+        if len(node.targets) == 1 and isinstance(target := node.targets[0], ast.Name):
+            self._set_target(target)  # noqa
+
+    #
+
+    def visit_Expr(self, node: ast.Expr) -> ta.Any:
+        if (
+                isinstance(node.value, ast.Constant) and
+                isinstance(node.value.value, str) and
+                self._prev_node_type in (ast.Assign, ast.AnnAssign)
+        ):
+            docstring = inspect.cleandoc(node.value.value)
+            if self._target:
+                ex = self._attr_docs.get(self._target, _EMPTY_ATTR_DOC)
+                check.none(ex.docstring)
+                self._attr_docs[self._target] = dc.replace(ex, docstring=docstring)
+            self._target = None
+
+
+def extract_attr_docs(src: str) -> ta.Mapping[str, AttrDoc]:
+    if not src:
+        return {}
+
+    toks = tks.src_to_tokens(src)
+    tok_lines = tks.split_lines_dense(toks)
+
+    src_ast = ast.parse(src)
+
+    # import astpretty
+    # astpretty.pprint(src_ast)
+
+    ast_visitor = _AttrDocAstVisitor(tok_lines=tok_lines)
+    ast_visitor.visit(src_ast)
+    return ast_visitor.attr_docs
+
+
+##
+
+
+# @omlish-manifest
+_CLI_MODULE = {'$omdev.cli.types.CliModule': {
+    'cmd_name': 'py/attrdocs',
+    'mod_name': __name__,
+}}
+
+
+if __name__ == '__main__':
+    def _main() -> None:
+        import argparse
+
+        parser = argparse.ArgumentParser()
+        parser.add_argument('file')
+        args = parser.parse_args()
+
+        #
+
+        with open(args.file) as f:
+            src = f.read()
+
+        attr_docs = extract_attr_docs(src)
+
+        #
+
+        import json
+
+        print(json.dumps({
+            a: {k: v for k, v in dc.asdict(ad).items() if v}
+            for a, ad in sorted(attr_docs.items(), key=lambda t: t[0])
+        }))
+
+    _main()

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/bracepy.py

@@ -7,6 +7,9 @@ import io
 import tokenize
 
 
+##
+
+
 def translate_brace_python(
         s: str,
         *,
@@ -85,6 +88,9 @@ def translate_brace_python(
     return ret.getvalue()
 
 
+##
+
+
 # @omlish-manifest
 _CLI_MODULE = {'$omdev.cli.types.CliModule': {
     'cmd_name': 'bracepy',

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/classdot.py

@@ -10,6 +10,9 @@ from omlish.graphs import dot
 from .cli import CliModule
 
 
+##
+
+
 def gen_class_dot(roots: ta.Iterable[type]) -> dot.Graph:
     roots = set(roots)
     root_tup = tuple(roots)

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/cmake.py

@@ -4,6 +4,9 @@ import typing as ta
 from omlish import dataclasses as dc
 
 
+##
+
+
 @dc.dataclass(frozen=True)
 class Command:
     name: str

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/findimports.py

@@ -13,6 +13,9 @@ import sys
 import typing as ta
 
 
+##
+
+
 _BUILTIN_MODULE_NAMES = frozenset([*sys.builtin_module_names, *sys.stdlib_module_names])
 
 
@@ -78,6 +81,9 @@ def get_import_deps(imps: set[str]) -> set[str]:
     return {i for i in eimps if whichmod(i) != 'builtin'}
 
 
+##
+
+
 # @omlish-manifest
 _CLI_MODULE = {'$omdev.cli.types.CliModule': {
     'cmd_name': 'py/findimports',

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/imgur.py

@@ -36,6 +36,9 @@ from .cli import CliModule
 from .home.secrets import load_secrets
 
 
+##
+
+
 @dc.dataclass(frozen=True)
 @msh.update_object_metadata(unknown_field='x')
 class ImageUploadData:

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/tokens/all.py

@@ -14,6 +14,7 @@ from .utils import (  # noqa
     ignore_ws,
 
     split_lines,
+    split_lines_dense,
     join_toks,
     join_lines,
 

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev/tokens/utils.py

@@ -42,6 +42,15 @@ def split_lines(ts: Tokens) -> list[Tokens]:
     return [list(it) for g, it in itertools.groupby(ts, lambda t: t.line)]
 
 
+def split_lines_dense(ts: Tokens) -> list[Tokens]:
+    lines: list[list[Token]] = []
+    for t in ts:
+        while len(lines) < (t.line or 0):
+            lines.append([])
+        lines[-1].append(t)
+    return lines  # type: ignore[return-value]
+
+
 def join_toks(ts: Tokens) -> str:
     return ''.join(t.src for t in ts)
 

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283/omdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: omdev
-Version: 0.0.0.dev282
+Version: 0.0.0.dev283
 Summary: omdev
 Author: wrmsr
 License: BSD-3-Clause
@@ -12,7 +12,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Operating System :: POSIX
 Requires-Python: >=3.12
 License-File: LICENSE
-Requires-Dist: omlish==0.0.0.dev282
+Requires-Dist: omlish==0.0.0.dev283
 Provides-Extra: all
 Requires-Dist: black~=25.1; extra == "all"
 Requires-Dist: pycparser~=2.22; extra == "all"

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ pyproject.toml
 omdev/.manifests.json
 omdev/__about__.py
 omdev/__init__.py
+omdev/attrdocs.py
 omdev/bracepy.py
 omdev/classdot.py
 omdev/cmake.py

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/omdev.egg-info/requires.txt

@@ -1,4 +1,4 @@
-omlish==0.0.0.dev282
+omlish==0.0.0.dev283
 
 [all]
 black~=25.1

{omdev-0.0.0.dev282 → omdev-0.0.0.dev283}/pyproject.toml

@@ -12,7 +12,7 @@ authors = [
 urls = {source = 'https://github.com/wrmsr/omlish'}
 license = {text = 'BSD-3-Clause'}
 requires-python = '>=3.12'
-version = '0.0.0.dev282'
+version = '0.0.0.dev283'
 classifiers = [
     'License :: OSI Approved :: BSD License',
     'Development Status :: 2 - Pre-Alpha',
@@ -22,7 +22,7 @@ classifiers = [
 ]
 description = 'omdev'
 dependencies = [
-    'omlish == 0.0.0.dev282',
+    'omlish == 0.0.0.dev283',
 ]
 
 [project.optional-dependencies]