hal.meta package

Submodules

hal.meta.attributes module

Finds attributes of classes and functions in files

class hal.meta.attributes.ModuleFile(path, root_package)[source]

Bases: object

File attributes

get_tree()[source]

Finds tree hierarchy of file

Returns:Tree
class hal.meta.attributes.ModuleTree(tree, root_package)[source]

Bases: object

Hierarchy

get_classes()[source]

Finds classes in file

Returns:list of top-level classes
get_functions()[source]

Finds top-level functions in file

Returns:list of top-level functions
get_name()[source]

Finds name of tree

Returns:name
class hal.meta.attributes.ModuleTreeObject(tree, root_package)[source]

Bases: hal.meta.attributes.ModuleTree

Object of Python tree

class hal.meta.attributes.PyClass(tree, root_package)[source]

Bases: hal.meta.attributes.ModuleTreeObject

Python parsed class

get_functions(include_meta=False)[source]

Finds top-level functions in file

Parameters:include_meta – whether include meta functions like (__init__)
Returns:list of top-level functions
class hal.meta.attributes.PyFunction(tree, root_package)[source]

Bases: hal.meta.attributes.ModuleTreeObject

Python parsed method

hal.meta.attributes.get_class_name(obj)[source]

Finds name of class of object

Parameters:obj – object
Returns:Name of class
hal.meta.attributes.get_method_name(func)[source]

Finds name of method

Parameters:func – method
Returns:Name of method
hal.meta.attributes.get_modules(folder, include_meta=False)[source]

Finds modules (recursively) in folder

Parameters:
  • folder – root folder
  • include_meta – whether include meta files like (__init__ or __version__)
Returns:

list of modules