polymerist.genutils.importutils.pyimports
=========================================

.. py:module:: polymerist.genutils.importutils.pyimports

.. autoapi-nested-parse::

   For inspecting and managing toplevel imports within Python files and modules



Classes
-------

.. autoapisummary::

   polymerist.genutils.importutils.pyimports.ImportedObjectInfo


Functions
---------

.. autoapisummary::

   polymerist.genutils.importutils.pyimports.extract_imports_from_pyfile
   polymerist.genutils.importutils.pyimports.extract_imports_from_dir
   polymerist.genutils.importutils.pyimports.extract_imports_from_module


Module Contents
---------------

.. py:class:: ImportedObjectInfo

   For encapsulating info about an object imported in a Python file


   .. py:attribute:: object_name
      :type:  str


   .. py:attribute:: object_alias
      :type:  Optional[str]
      :value: None



   .. py:attribute:: parent_module
      :type:  Optional[str]
      :value: None



   .. py:attribute:: source_file
      :type:  Optional[pathlib.Path]
      :value: None



   .. py:attribute:: line_number
      :type:  Optional[int]
      :value: None



   .. py:attribute:: is_relative
      :type:  Optional[bool]
      :value: None



.. py:function:: extract_imports_from_pyfile(pyfile_path: pathlib.Path) -> list[ImportedObjectInfo]

   Compiles info from all Python imports in a Python (.py) file


.. py:function:: extract_imports_from_dir(source_dir: pathlib.Path) -> list[ImportedObjectInfo]

   Compiles info from all Python imports in any and all Python files in a directory


.. py:function:: extract_imports_from_module(module: types.ModuleType) -> list[ImportedObjectInfo]

   Compiles info from all Python imports in a Python (.py) file