scitex 2.15.1__py3-none-any.whl → 2.15.2__py3-none-any.whl

scitex/dev/__init__.py

@@ -1,20 +1,39 @@
 #!/usr/bin/env python3
-"""Scitex dev module."""
+"""Scitex dev module - Development and debugging utilities."""
 
 # Pyproject utilities (lazy import to avoid tomlkit dependency)
+# Installation guide utilities (moved from root scitex module)
+from .._install_guide import (
+    MODULE_REQUIREMENTS,
+    check_module_deps,
+    require_module,
+    requires,
+    show_install_guide,
+    warn_module_deps,
+)
 from . import _pyproject as pyproject
 from . import cv
 from ._analyze_code_flow import CodeFlowAnalyzer, analyze_code_flow, main, parse_args
 from ._reload import reload, reload_auto, reload_stop
 
 __all__ = [
+    # Code flow analysis
     "CodeFlowAnalyzer",
     "analyze_code_flow",
     "main",
     "parse_args",
+    # Hot reloading
     "reload",
     "reload_auto",
     "reload_stop",
+    # Submodules
     "pyproject",
     "cv",
+    # Installation guide utilities
+    "show_install_guide",
+    "check_module_deps",
+    "require_module",
+    "requires",
+    "warn_module_deps",
+    "MODULE_REQUIREMENTS",
 ]

scitex/gen/__init__.py

@@ -1,15 +1,45 @@
 #!/usr/bin/env python3
-"""Scitex gen module."""
+"""Scitex gen module.
+
+NOTE: This module is being refactored. Many functions are being moved to
+more appropriate locations. For backward compatibility, they are re-exported
+here with deprecation warnings.
+
+Recommended imports:
+- ci -> scitex.stats.descriptive.ci
+- check_host, is_host, verify_host -> scitex.os
+- detect_environment, is_notebook, is_script -> scitex.context
+- list_api -> scitex.introspect
+- run_shellcommand, run_shellscript -> scitex.sh
+- xml2dict, XmlDictConfig, XmlListConfig -> scitex.io
+- title_case -> scitex.str
+- symlink -> scitex.path
+"""
+
+import warnings
+
+
+def _deprecation_warning(old_path, new_path):
+    warnings.warn(
+        f"{old_path} is deprecated, use {new_path} instead",
+        DeprecationWarning,
+        stacklevel=3,
+    )
+
+
+# ci -> scitex.stats.descriptive.ci (with re-export for backward compat)
+from scitex.stats.descriptive import ci
 
 # Optional: DimHandler requires torch
 try:
     from ._DimHandler import DimHandler
 except ImportError:
     DimHandler = None
+# check_host moved to scitex.os (re-export for backward compatibility)
+from scitex.os import check_host, is_host, verify_host
+
 from ._alternate_kwarg import alternate_kwarg
 from ._cache import cache
-from ._check_host import check_host, is_host, verify_host
-from ._ci import ci
 from ._deprecated_close import (
     close as _deprecated_close,
 )
@@ -27,7 +57,9 @@ try:
     from ._embed import embed
 except ImportError:
     embed = None
-from ._inspect_module import inspect_module
+# list_api moved to scitex.introspect (re-export for backward compatibility)
+from scitex.introspect import list_api
+
 from ._is_ipython import is_ipython, is_script
 from ._less import less
 from ._list_packages import list_packages, main
@@ -51,9 +83,11 @@ except ImportError:
     to_nanz = None
     to_z = None
     unbias = None
+# shell functions moved to scitex.sh (re-export for backward compatibility)
+from scitex.sh import run_shellcommand, run_shellscript
+
 from ._paste import paste
 from ._print_config import print_config, print_config_main
-from ._shell import run_shellcommand, run_shellscript
 from ._src import src
 from ._TimeStamper import TimeStamper
 
@@ -62,20 +96,23 @@ start = _deprecated_start
 close = _deprecated_close
 running2finished = _deprecated_running2finished
 
-from ._detect_environment import (
+# environment detection moved to scitex.context (re-export for backward compatibility)
+from scitex.context import (
     detect_environment,
-    get_output_directory,
-    is_notebook,
-)
-from ._get_notebook_path import (
     get_notebook_directory,
+    get_notebook_info_simple,
     get_notebook_name,
     get_notebook_path,
+    get_output_directory,
+    is_notebook,
 )
+
+# title_case moved to scitex.str (re-export for backward compatibility)
+from scitex.str import title_case
+
 from ._symlink import symlink
 from ._symlog import symlog
 from ._title2path import title2path
-from ._title_case import main, title_case
 from ._to_even import to_even
 from ._to_odd import to_odd
 
@@ -99,10 +136,9 @@ except ImportError:
     pass  # Already set to None above
 from ._wrap import wrap
 from ._xml2dict import XmlDictConfig, XmlListConfig, xml2dict
-from .misc import float_linspace
 
 # Import from misc module
-from .misc import connect_nums
+from .misc import connect_nums, float_linspace
 
 __all__ = [
     "ArrayLike",
@@ -122,7 +158,7 @@ __all__ = [
     "dir2npy",
     "embed",
     "float_linspace",
-    "inspect_module",
+    "list_api",
     "is_host",
     "is_ipython",
     "is_script",

scitex/gen/_list_packages.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # Time-stamp: "2024-11-03 02:11:54 (ywatanabe)"
 # File: ./scitex_repo/src/scitex/gen/_list_packages.py
 """
@@ -25,8 +24,6 @@ except ImportError:
     # Fallback for older Python versions
     from importlib_metadata import distributions
 
-from ._inspect_module import inspect_module
-
 
 def list_packages(
     max_depth: int = 1,
@@ -80,10 +77,12 @@ def list_packages(
         pkg for pkg in installed_packages if pkg not in safelist
     ]
 
+    from scitex.introspect import list_api
+
     all_dfs = []
     for package_name in installed_packages:
         try:
-            df = inspect_module(
+            df = list_api(
                 package_name,
                 docstring=False,  # Speed up by skipping docstrings
                 print_output=False,
@@ -116,6 +115,7 @@ def main() -> Optional[int]:
 
 if __name__ == "__main__":
     import matplotlib.pyplot as plt
+
     import scitex
 
     CONFIG, sys.stdout, sys.stderr, plt, CC = scitex.session.start(

scitex/introspect/__init__.py

@@ -7,11 +7,14 @@ Introspection utilities for Python packages.
 
 Provides IPython-like introspection capabilities for any Python package.
 
+IPython-style shortcuts:
+- q: Function/class signature with type hints (like `func?`)
+- qq: Full source code (like `func??`)
+- dir: List attributes/methods (like `dir()`)
+- list_api: Recursive module API tree
+
 Basic Introspection:
-- get_signature: Function/class signature with type hints (like `func?`)
 - get_docstring: Docstring extraction with parsing
-- get_source: Full source code (like `func??`)
-- list_members: List attributes/methods (like `dir()`)
 - get_exports: Module's __all__ contents
 - find_examples: Find usage examples in tests/examples
 
@@ -27,6 +30,8 @@ Advanced Introspection:
 """
 
 from ._core import (
+    # IPython-style names
+    dir,
     # Basic
     find_examples,
     # Advanced - Call graph
@@ -42,20 +47,22 @@ from ._core import (
     get_function_calls,
     get_imports,
     get_mro,
-    get_signature,
-    get_source,
     get_type_hints_detailed,
     get_type_info,
-    list_members,
+    q,
+    qq,
     resolve_object,
 )
+from ._list_api import list_api
 
 __all__ = [
+    # IPython-style names
+    "q",
+    "qq",
+    "dir",
+    "list_api",
     # Basic
-    "get_signature",
     "get_docstring",
-    "get_source",
-    "list_members",
     "get_exports",
     "find_examples",
     "resolve_object",

scitex/introspect/_core.py

@@ -4,25 +4,24 @@
 
 """Core introspection module - re-exports all utilities."""
 
-# Basic introspection
-# Advanced introspection
 from ._call_graph import get_call_graph, get_function_calls
 from ._class_hierarchy import get_class_hierarchy, get_mro
 from ._docstring import get_docstring
 from ._examples import find_examples
 from ._imports import get_dependencies, get_imports
-from ._members import get_exports, list_members
+from ._members import dir, get_exports
 from ._resolve import get_type_info, resolve_object
-from ._signature import get_signature
-from ._source import get_source
+from ._signature import q
+from ._source import qq
 from ._type_hints import get_class_annotations, get_type_hints_detailed
 
 __all__ = [
+    # IPython-style names
+    "q",  # signature (like func?)
+    "qq",  # source (like func??)
+    "dir",  # members (like dir())
     # Basic
-    "get_signature",
     "get_docstring",
-    "get_source",
-    "list_members",
     "get_exports",
     "find_examples",
     "resolve_object",

scitex/{gen/_inspect_module.py → introspect/_list_api.py}

@@ -1,18 +1,18 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Time-stamp: "2024-11-07 18:58:55 (ywatanabe)"
-# File: ./scitex_repo/src/scitex/gen/_inspect_module.py
+# Timestamp: 2025-01-27
+# File: /home/ywatanabe/proj/scitex-python/src/scitex/introspect/_list_api.py
+
+"""Module API listing utilities."""
 
 import inspect
 import sys
 import warnings
 from typing import Any, List, Optional, Set, Union
 
-import scitex
 import pandas as pd
 
 
-def inspect_module(
+def list_api(
     module: Union[str, Any],
     columns: List[str] = ["Type", "Name", "Docstring", "Depth"],
     prefix: str = "",
@@ -26,41 +26,14 @@ def inspect_module(
     drop_duplicates: bool = True,
     root_only: bool = False,
 ) -> pd.DataFrame:
-    return _inspect_module(
-        module=module,
-        prefix=prefix,
-        max_depth=max_depth,
-        visited=visited,
-        docstring=docstring,
-        tree=tree,
-        current_depth=current_depth,
-        print_output=print_output,
-        skip_depwarnings=skip_depwarnings,
-        drop_duplicates=drop_duplicates,
-        root_only=root_only,
-    )[columns]
-
+    """
+    List the API of a module recursively and return as a DataFrame.
 
-def _inspect_module(
-    module: Union[str, Any],
-    columns: List[str] = ["Type", "Name", "Docstring", "Depth"],
-    prefix: str = "",
-    max_depth: int = 5,
-    visited: Optional[Set[str]] = None,
-    docstring: bool = False,
-    tree: bool = True,
-    current_depth: int = 0,
-    print_output: bool = False,
-    skip_depwarnings: bool = True,
-    drop_duplicates: bool = True,
-    root_only: bool = False,
-) -> pd.DataFrame:
-    """List the contents of a module recursively and return as a DataFrame.
+    Like a recursive `dir()` that shows the entire module tree.
 
     Example
     -------
-    >>>
-    >>> df = inspect_module(scitex)
+    >>> df = list_api(scitex)
     >>> print(df)
        Type           Name                    Docstring  Depth
     0    M            scitex  Module description              0
@@ -100,6 +73,36 @@ def _inspect_module(
     pd.DataFrame
         Module structure with specified columns
     """
+    return _list_api_impl(
+        module=module,
+        prefix=prefix,
+        max_depth=max_depth,
+        visited=visited,
+        docstring=docstring,
+        tree=tree,
+        current_depth=current_depth,
+        print_output=print_output,
+        skip_depwarnings=skip_depwarnings,
+        drop_duplicates=drop_duplicates,
+        root_only=root_only,
+    )[columns]
+
+
+def _list_api_impl(
+    module: Union[str, Any],
+    columns: List[str] = ["Type", "Name", "Docstring", "Depth"],
+    prefix: str = "",
+    max_depth: int = 5,
+    visited: Optional[Set[str]] = None,
+    docstring: bool = False,
+    tree: bool = True,
+    current_depth: int = 0,
+    print_output: bool = False,
+    skip_depwarnings: bool = True,
+    drop_duplicates: bool = True,
+    root_only: bool = False,
+) -> pd.DataFrame:
+    """Internal implementation of list_api."""
     if skip_depwarnings:
         warnings.filterwarnings("ignore", category=DeprecationWarning)
         warnings.filterwarnings("ignore", category=UserWarning)
@@ -150,7 +153,7 @@ def _inspect_module(
                         )
                     )
                     try:
-                        sub_df = _inspect_module(
+                        sub_df = _list_api_impl(
                             obj,
                             columns=columns,
                             prefix=full_path,
@@ -235,22 +238,8 @@ def _print_module_contents(df: pd.DataFrame) -> None:
 
 
 if __name__ == "__main__":
+    import scitex
+
     sys.setrecursionlimit(10_000)
-    df = inspect_module(scitex, docstring=True, print_output=False, columns=["Name"])
+    df = list_api(scitex, docstring=True, print_output=False, columns=["Name"])
     print(scitex.pd.round(df))
-    #                                 Name
-    # 0                               scitex
-    # 1                            scitex.ai
-    # 3     scitex.ai.ClassificationReporter
-    # 4           scitex.ai.ClassifierServer
-    # 5              scitex.ai.EarlyStopping
-    # ...                              ...
-    # 5373                     scitex.typing
-    # 5375                 scitex.typing.Any
-    # 5376            scitex.typing.Iterable
-    # 5377                        scitex.web
-    # 5379          scitex.web.summarize_url
-
-    # [5361 rows x 1 columns]
-
-# EOF

scitex/introspect/_mcp/__init__.py

@@ -9,23 +9,27 @@ from .handlers import (
     call_graph_handler,
     class_hierarchy_handler,
     dependencies_handler,
+    # IPython-style names
+    dir_handler,
     # Basic
     docstring_handler,
     examples_handler,
     exports_handler,
     imports_handler,
-    members_handler,
-    signature_handler,
-    source_handler,
+    list_api_handler,
+    q_handler,
+    qq_handler,
     type_hints_handler,
 )
 
 __all__ = [
+    # IPython-style names
+    "q_handler",
+    "qq_handler",
+    "dir_handler",
+    "list_api_handler",
     # Basic
-    "signature_handler",
     "docstring_handler",
-    "source_handler",
-    "members_handler",
     "exports_handler",
     "examples_handler",
     # Advanced

scitex/introspect/_mcp/handlers.py

@@ -9,16 +9,16 @@ from __future__ import annotations
 from typing import Literal
 
 
-async def signature_handler(
+async def q_handler(
     dotted_path: str,
     include_defaults: bool = True,
     include_annotations: bool = True,
 ) -> dict:
-    """Get the signature of a function, method, or class."""
+    """Get the signature of a function, method, or class (like IPython's func?)."""
     try:
-        from .. import get_signature
+        from .. import q
 
-        result = get_signature(
+        result = q(
             dotted_path,
             include_defaults=include_defaults,
             include_annotations=include_annotations,
@@ -42,16 +42,16 @@ async def docstring_handler(
         return {"success": False, "error": str(e)}
 
 
-async def source_handler(
+async def qq_handler(
     dotted_path: str,
     max_lines: int | None = None,
     include_decorators: bool = True,
 ) -> dict:
-    """Get the source code of a Python object."""
+    """Get the source code of a Python object (like IPython's func??)."""
     try:
-        from .. import get_source
+        from .. import qq
 
-        result = get_source(
+        result = qq(
             dotted_path,
             max_lines=max_lines,
             include_decorators=include_decorators,
@@ -61,17 +61,17 @@ async def source_handler(
         return {"success": False, "error": str(e)}
 
 
-async def members_handler(
+async def dir_handler(
     dotted_path: str,
     filter: Literal["all", "public", "private", "dunder"] = "public",
     kind: Literal["all", "functions", "classes", "data", "modules"] | None = None,
     include_inherited: bool = False,
 ) -> dict:
-    """List members of a module or class."""
+    """List members of a module or class (like dir())."""
     try:
-        from .. import list_members
+        from .. import dir
 
-        result = list_members(
+        result = dir(
             dotted_path,
             filter=filter,
             kind=kind,
@@ -206,3 +206,28 @@ async def call_graph_handler(
         return result
     except Exception as e:
         return {"success": False, "error": str(e)}
+
+
+async def list_api_handler(
+    dotted_path: str,
+    max_depth: int = 5,
+    docstring: bool = False,
+    root_only: bool = False,
+) -> dict:
+    """List the API tree of a module recursively."""
+    try:
+        from .. import list_api
+
+        df = list_api(
+            dotted_path,
+            max_depth=max_depth,
+            docstring=docstring,
+            root_only=root_only,
+        )
+        return {
+            "success": True,
+            "api": df.to_dict(orient="records"),
+            "count": len(df),
+        }
+    except Exception as e:
+        return {"success": False, "error": str(e)}

scitex/introspect/_members.py

@@ -6,13 +6,17 @@
 
 from __future__ import annotations
 
+import builtins
 import inspect
 from typing import Literal
 
 from ._resolve import get_type_info, resolve_object
 
+# Save reference to built-in dir before shadowing
+_builtin_dir = builtins.dir
 
-def list_members(
+
+def dir(
     dotted_path: str,
     filter: Literal["all", "public", "private", "dunder"] = "public",
     kind: Literal["all", "functions", "classes", "data", "modules"] | None = None,
@@ -53,7 +57,7 @@ def list_members(
     if inspect.isclass(obj) and not include_inherited:
         member_names = list(obj.__dict__.keys())
     else:
-        member_names = dir(obj)
+        member_names = _builtin_dir(obj)
 
     if filter == "public":
         member_names = [n for n in member_names if not n.startswith("_")]
@@ -137,7 +141,7 @@ def get_exports(dotted_path: str) -> dict:
     exports = getattr(obj, "__all__", None)
 
     if exports is None:
-        exports = [n for n in dir(obj) if not n.startswith("_")]
+        exports = [n for n in _builtin_dir(obj) if not n.startswith("_")]
         has_all = False
     else:
         has_all = True

scitex/introspect/_signature.py

@@ -45,7 +45,7 @@ def _build_signature_string(
     return sig
 
 
-def get_signature(
+def q(
     dotted_path: str,
     include_defaults: bool = True,
     include_annotations: bool = True,
@@ -53,7 +53,7 @@ def get_signature(
     """
     Get the signature of a function, method, or class.
 
-    Like IPython's `func?` but returns structured data.
+    Like IPython's `func?` (quick info).
 
     Parameters
     ----------
@@ -75,7 +75,7 @@ def get_signature(
 
     Examples
     --------
-    >>> get_signature("scitex.plt.plot")
+    >>> q("scitex.plt.plot")
     {'name': 'plot', 'signature': 'plot(spec: dict, ...) -> dict', ...}
     """
     obj, error = resolve_object(dotted_path)

scitex/introspect/_source.py

@@ -11,7 +11,7 @@ import inspect
 from ._resolve import get_type_info, resolve_object
 
 
-def get_source(
+def qq(
     dotted_path: str,
     max_lines: int | None = None,
     include_decorators: bool = True,
@@ -19,7 +19,7 @@ def get_source(
     """
     Get the source code of a Python object.
 
-    Like IPython's `func??`.
+    Like IPython's `func??` (full source).
 
     Parameters
     ----------

scitex/io/_save.py

@@ -188,8 +188,7 @@ def _determine_save_path(specified_path, use_caller_path):
     if specified_path.startswith("/"):
         return specified_path
 
-    from scitex.gen._detect_environment import detect_environment
-    from scitex.gen._get_notebook_path import get_notebook_info_simple
+    from scitex.context import detect_environment, get_notebook_info_simple
 
     env_type = detect_environment()