astToolkit 0.3.3__tar.gz → 0.3.4__tar.gz

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: astToolkit
-Version: 0.3.3
+Version: 0.3.4
 Summary: A powerfully composable, type-safe toolkit for Python abstract syntax tree (AST) manipulation, analysis, transformation, and code generation with a layered architecture designed for building sophisticated code processing assembly-lines.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License: CC-BY-NC-4.0

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/astToolkit/__init__.py

@@ -28,6 +28,8 @@ from astToolkit._types import (
 	str_nameDOTname as str_nameDOTname,
 )
 
+from astToolkit._dumpFunctionDef import dump as dump
+
 from astToolkit._toolkitNodeVisitor import (
 	NodeChanger as NodeChanger,
 	NodeTourist as NodeTourist,

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/astToolkit/_astTypes.py

@@ -1,5 +1,5 @@
 """This file is generated automatically, so changes to this file will be lost."""
-from typing import Any, TypeAlias as typing_TypeAlias, TypeVar as typing_TypeVar
+from typing import Any, TypeAlias as typing_TypeAlias, TypedDict, TypeVar as typing_TypeVar
 import ast
 import sys
 intORstr: typing_TypeAlias = Any
@@ -8,6 +8,12 @@ intORtype_params: typing_TypeAlias = Any
 木 = typing_TypeVar('木', bound=ast.AST, covariant=True)
 个 = typing_TypeVar('个', covariant=True)
 个return = typing_TypeVar('个return', covariant=True)
+
+class ast_attributes(TypedDict, total=False):
+    lineno: int
+    col_offset: int
+    end_lineno: int | None
+    end_col_offset: int | None
 hasDOTannotation_expr: typing_TypeAlias = ast.AnnAssign
 hasDOTannotation_exprOrNone: typing_TypeAlias = ast.arg
 hasDOTannotation: typing_TypeAlias = hasDOTannotation_expr | hasDOTannotation_exprOrNone

asttoolkit-0.3.4/astToolkit/_dumpFunctionDef.py

@@ -0,0 +1,76 @@
+from _ast import *
+
+def dump(node, annotate_fields=True, include_attributes=False, *, indent=None, show_empty=False):
+    """
+    Return a formatted dump of the tree in node.  This is mainly useful for
+    debugging purposes.  If annotate_fields is true (by default),
+    the returned string will show the names and the values for fields.
+    If annotate_fields is false, the result string will be more compact by
+    omitting unambiguous field names.  Attributes such as line
+    numbers and column offsets are not dumped by default.  If this is wanted,
+    include_attributes can be set to true.  If indent is a non-negative
+    integer or string, then the tree will be pretty-printed with that indent
+    level. None (the default) selects the single line representation.
+    If show_empty is False, then empty lists and fields that are None
+    will be omitted from the output for better readability.
+    """
+
+    def _format(node, level=0):
+        if indent is not None:
+            level += 1
+            prefix = '\n' + indent * level
+            sep = ',\n' + indent * level
+        else:
+            prefix = ''
+            sep = ', '
+        if isinstance(node, AST):
+            cls = type(node)
+            args = []
+            args_buffer = []
+            allsimple = True
+            keywords = annotate_fields
+            for name in node._fields:
+                try:
+                    value = getattr(node, name)
+                except AttributeError:
+                    keywords = True
+                    continue
+                if value is None and getattr(cls, name, ...) is None:
+                    keywords = True
+                    continue
+                if not show_empty and (value is None or value == []) and (not isinstance(node, (Constant, MatchSingleton))):
+                    args_buffer.append(repr(value))
+                    continue
+                elif not keywords:
+                    args.extend(args_buffer)
+                    args_buffer = []
+                value, simple = _format(value, level)
+                allsimple = allsimple and simple
+                if keywords:
+                    args.append('%s=%s' % (name, value))
+                else:
+                    args.append(value)
+            if include_attributes and node._attributes:
+                for name in node._attributes:
+                    try:
+                        value = getattr(node, name)
+                    except AttributeError:
+                        continue
+                    if value is None and getattr(cls, name, ...) is None:
+                        continue
+                    value, simple = _format(value, level)
+                    allsimple = allsimple and simple
+                    args.append('%s=%s' % (name, value))
+            if allsimple and len(args) <= 3:
+                return ('%s(%s)' % ('ast.' + node.__class__.__name__, ', '.join(args)), not args)
+            return ('%s(%s%s)' % ('ast.' + node.__class__.__name__, prefix, sep.join(args)), False)
+        elif isinstance(node, list):
+            if not node:
+                return ('[]', True)
+            return ('[%s%s]' % (prefix, sep.join((_format(x, level)[0] for x in node))), False)
+        return (repr(node), True)
+    if not isinstance(node, AST):
+        raise TypeError('expected AST, got %r' % node.__class__.__name__)
+    if indent is not None and (not isinstance(indent, str)):
+        indent = ' ' * indent
+    return _format(node)[0]

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/astToolkit/_toolBe.py

@@ -1,7 +1,6 @@
 """This file is generated automatically, so changes to this file will be lost."""
 from typing import TypeGuard
 import ast
-import sys
 
 class Be:
     """

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/astToolkit/_toolkitAST.py

@@ -22,9 +22,6 @@ def astModuleToIngredientsFunction(astModule: ast.AST, identifierFunctionDef: st
 	Returns:
 		ingredientsFunction: `IngredientsFunction` object containing the `ast.FunctionDef` and _all_ imports from the
 		source module.
-
-	Raises:
-		FREAKOUT: If the function definition is not found.
 	"""
 	astFunctionDef = raiseIfNone(extractFunctionDef(astModule, identifierFunctionDef))
 	return IngredientsFunction(astFunctionDef, LedgerOfImports(astModule))
@@ -74,10 +71,9 @@ def parseLogicalPath2astModule(logicalPathModule: str_nameDOTname, packageIdenti
 		The logical path to the module using dot notation (e.g., 'package.module').
 	packageIdentifierIfRelative : None
 		The package identifier to use if the module path is relative, defaults to None.
-	mode : Literal['exec']
-		The mode parameter for `ast.parse`. Default is `Literal['exec']`. Options are `Literal['exec']`, `"exec"` (which
-		is _not_ the same as `Literal['exec']`), `Literal['eval']`, `Literal['func_type']`, `Literal['single']`. See
-		`ast.parse` documentation for some details and much confusion.
+	mode : 'exec'
+		The mode parameter for `ast.parse`. Default is `'exec'`. Options are `'exec'`, `'eval'`, `'func_type'`, `'single'`. See
+		`ast.parse` documentation.
 
 	Returns
 	-------
@@ -99,10 +95,9 @@ def parsePathFilename2astModule(pathFilename: PathLike[Any] | PurePath, mode: Li
 	----------
 	pathFilename
 		The path to the file to be parsed. Can be a string path, PathLike object, or PurePath object.
-	mode : Literal['exec']
-		The mode parameter for `ast.parse`. Default is `Literal['exec']`. Options are `Literal['exec']`, `"exec"` (which
-		is _not_ the same as `Literal['exec']`), `Literal['eval']`, `Literal['func_type']`, `Literal['single']`. See
-		`ast.parse` documentation for some details and much confusion.
+	mode : 'exec'
+		The mode parameter for `ast.parse`. Default is `'exec'`. Options are `'exec'`, `'eval'`, `'func_type'`, `'single'`. See
+		`ast.parse` documentation.
 
 	Returns
 	-------

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/astToolkit/_types.py

@@ -1,6 +1,5 @@
-from typing import Any, TypeAlias as typing_TypeAlias, TypeVar as typing_TypeVar
+from typing import TypeAlias as typing_TypeAlias
 import ast
-import sys
 
 # Type hints through TypeAlias or type "hints" through the identifier name.
 str_nameDOTname: typing_TypeAlias = str

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/astToolkit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: astToolkit
-Version: 0.3.3
+Version: 0.3.4
 Summary: A powerfully composable, type-safe toolkit for Python abstract syntax tree (AST) manipulation, analysis, transformation, and code generation with a layered architecture designed for building sophisticated code processing assembly-lines.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License: CC-BY-NC-4.0

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/astToolkit.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 astToolkit/__init__.py
 astToolkit/_astTypes.py
+astToolkit/_dumpFunctionDef.py
 astToolkit/_joinClassmethod.py
 astToolkit/_theSSOT.py
 astToolkit/_toolBe.py

{asttoolkit-0.3.3 → asttoolkit-0.3.4}/pyproject.toml

@@ -36,7 +36,7 @@ optional-dependencies = { testing = [
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.12"
 urls = { Donate = "https://www.patreon.com/integrated", Homepage = "https://github.com/hunterhogan/astToolkit", Issues = "https://github.com/hunterhogan/astToolkit/issues", Repository = "https://github.com/hunterhogan/astToolkit.git" }
-version = "0.3.3"
+version = "0.3.4"
 
 [tool.coverage]
 report = { exclude_lines = [