Package pyplusplus :: Package decl_wrappers :: Module decl_wrapper :: Class decl_wrapper_t

# type decl_wrapper_t

source code

    object --+
             |
            decl_wrapper_t

Known Subclasses:
  - variable_wrapper.variable_t
  - , enumeration_wrapper.enumeration_t
  - , typedef_wrapper.typedef_t
  - , class_wrapper.class_declaration_t
  - , scopedef_wrapper.scopedef_t
  - , calldef_wrapper.calldef_t

code generator declaration configuration base class

This class contains configuration that could be applied to all declarations.

Instance Methods

__init__(self) | source code

rename(self, new_name) give new name to the declaration, under which Python will know the declaration | source code

get_already_exposed(self) | source code

set_already_exposed(self, value) | source code

exclude(self, compilation_errors=False) exclude "self" and child declarations from being exposed. | source code

include(self, already_exposed=False) include "self" and child declarations to be exposed. | source code

why_not_exportable(self) return the reason( string ) that explains why this declaration could not be exported | source code

get_exportable(self) return True if declaration could be exposed to Python, False otherwise | source code

set_exportable(self, exportable) change "exportable" status | source code

readme(self, skip_ignored=True) return important information( hints/tips/warning message ) Py++ has about this declaration. | source code

disable_messages(self, *args) set messages, which should not be reported to you | source code

disable_warnings(self, *args) set messages, which should not be reported to you | source code

Class Variables
| SPECIAL_TYPEDEF_PICK_ANY = `True`

Properties
| logger reference to _logging_.loggers.declarations
| documentation exposed declaration Python documentation string
| alias the name under which, Python will know the declaration
| ignore boolean flag, which says whether to export declaration to Python or not
| already_exposed boolean flag, which says whether the declaration is already exposed or not
| exportable Returns True if declaration could be exported to Python, otherwise False
| disabled_messages list of messages to ignore
| include_files list of header files, to be included from the file, the generated code will be placed-in

Method Details

### __init__(self)
(Constructor)

source code

Overrides: object.__init__
  (inherited documentation)

### exclude(self, compilation_errors=False)

source code

exclude "self" and child declarations from being exposed.

If compile_time_errors is True, than only declarations, which will cause compilation error will be excluded

### why_not_exportable(self)

source code

return the reason( string ) that explains why this declaration could not be exported

If declaration could be exported, than method will return None

### set_exportable(self, exportable)

source code

change "exportable" status

This function should be use in case Py++ made a mistake and signed the declaration as unexportable.

### readme(self, skip_ignored=True)

source code

return important information( hints/tips/warning message ) Py++ has about this declaration.

skip_ignored argument allows you to control the information reported to you. For more information please read: http://www.language-binding.net/pyplusplus/documentation/warnings.html

### disable_messages(self, *args)

source code

set messages, which should not be reported to you

Usage example: decl.disable_messages( messages.W1001, messages.W1040 )

### disable_warnings(self, *args)

source code

set messages, which should not be reported to you

Usage example: decl.disable_messages( messages.W1001, messages.W1040 )

Property Details

### logger

reference to _logging_.loggers.declarations

### documentation

exposed declaration Python documentation string

Get Method:
  _get_documentation(self)
Set Method:
  _set_documentation(self, value)

### alias

the name under which, Python will know the declaration

Get Method:
  _get_alias(self)
Set Method:
  _set_alias(self, alias)

### ignore

boolean flag, which says whether to export declaration to Python or not

Get Method:
  _get_ignore(self)
Set Method:
  _set_ignore(self, value)

### already_exposed

boolean flag, which says whether the declaration is already exposed or not

Get Method:
  get_already_exposed(self)
Set Method:
  set_already_exposed(self, value)

### exportable

Returns True if declaration could be exported to Python, otherwise False

Get Method:
  get_exportable(self) - return True if declaration could be exposed to Python, False otherwise
Set Method:
  set_exportable(self, exportable) - change "exportable" status

### disabled_messages

list of messages to ignore

### include_files

list of header files, to be included from the file, the generated code will be placed-in