Public Member Functions
def	__init__ (self, pkg_name, file_path)

def	__repr__ (self)

def	write (self)

Public Attributes
	args

	changed

	declare_package_name

	file_path

	hash_bang

	helper_function

	helper_variable

	imports

	pkg_name

Detailed Description

Representation of a setup.py file, covering a large range of different styles

The core operation is generating the dictionary of arguments sent to the setup function.
If a helper function (like generate_distutils_setup) is used, there won't be many arguments.

Key fields:
hash_bang (bool) - Whether the file starts with a #!/usr/bin/env python
imports (list of tuples) - Used for generating the import statements like `from X import Y`
                           First element of tuple is a string of the name of the module (e.g. X)
                           Second element is the string(s) representing the function(s) to import (e.g. Y)
declare_package_name (bool) - Whether to declare the package name as a string for later use
helper_function (optional string) - Name of module to find the helper function to call (see HELPER_FUNCTIONS)
helper_variable (optional string) - Name of variable to store the results of the helper function in.
args (ordered dictionary) - Arguments to pass to setup/helper_function
                            The keys are regular strings that represent the name of the variable.
                            The values are more complex.

Definition at line 144 of file setup_py.py.

Constructor & Destructor Documentation

◆ init()

def ros_introspection.setup_py.SetupPy.__init__	(	self,
		pkg_name,
		file_path
	)

Definition at line 164 of file setup_py.py.

Member Function Documentation

◆ repr()

def ros_introspection.setup_py.SetupPy.__repr__ ( self )

Definition at line 239 of file setup_py.py.

◆ write()

def ros_introspection.setup_py.SetupPy.write ( self )

Definition at line 233 of file setup_py.py.

Member Data Documentation

◆ args

ros_introspection.setup_py.SetupPy.args

Definition at line 168 of file setup_py.py.

◆ changed

ros_introspection.setup_py.SetupPy.changed

Definition at line 171 of file setup_py.py.

◆ declare_package_name

ros_introspection.setup_py.SetupPy.declare_package_name

Definition at line 174 of file setup_py.py.

◆ file_path

ros_introspection.setup_py.SetupPy.file_path

Definition at line 166 of file setup_py.py.

◆ hash_bang

ros_introspection.setup_py.SetupPy.hash_bang

Definition at line 172 of file setup_py.py.

◆ helper_function

ros_introspection.setup_py.SetupPy.helper_function

Definition at line 175 of file setup_py.py.

◆ helper_variable

ros_introspection.setup_py.SetupPy.helper_variable

Definition at line 176 of file setup_py.py.

◆ imports

ros_introspection.setup_py.SetupPy.imports

Definition at line 173 of file setup_py.py.

◆ pkg_name

ros_introspection.setup_py.SetupPy.pkg_name

Definition at line 165 of file setup_py.py.

The documentation for this class was generated from the following file:

setup_py.py

Public Member Functions

Public Attributes