epydoc.objdoc.PropertyDoc

Package epydoc :: Module objdoc :: Class PropertyDoc |
[show private | hide private]
[frames | no frames]

## Class PropertyDoc

    ObjDoc --+
             |
            PropertyDoc

The documentation for a property. This documentation consists of standard pieces of documentation (as defined in `ObjDoc`), and the following property-specific pieces of documentation:

- fget: The property's get function
- fset: The property's set function
- fdel: The property's delete function
- type: The property's type

Method Summary
| `__init__(self, uid, typ, verbosity)`
| `__repr__(self)`
| ``_make_uid`(self, func, cls, functype)` Return a UID for the given fget/fset/fdel function of the property.
Inherited from `ObjDoc`: `_sort`
Accessors
`markup.ParsedDocstring` | ``type`(self)` Return a description of this property's type.
`UID` | ``fget`(self)` Return the UID of this property's get function.
`UID` | ``fset`(self)` Return the UID of this property's set function.
`UID` | ``fdel`(self)` Return the UID of this property's delete function.
Inherited from `ObjDoc`: `by_group`, `defines_groups`, `descr`, `field_values`, `fields`, `groups`, `has_docstring`, `sortorder`, `summary`, `uid`
Error Handling
Inherited from `ObjDoc`: `_print_errors`
Docstring Parsing
| ``_process_field`(self, tag, arg, descr, warnings)` Process a field from this object's docstring.

Instance Variable Summary
Inherited from `ObjDoc`: `_uid`
Error Handling
Inherited from `ObjDoc`: `_field_warnings`, `_misc_warnings`, `_parse_errors`, `_parse_warnings`
Docstring Parsing
Inherited from `ObjDoc`: `_descr`, `_fields`

Class Variable Summary
Docstring Parsing
Inherited from `ObjDoc`: `STANDARD_FIELDS`

Method Details

### type(self) Returns: A description of this property's type. (type=`markup.ParsedDocstring`)

### fget(self) Returns: The UID of this property's get function. (type=`UID`)

### fset(self) Returns: The UID of this property's set function. (type=`UID`)

### fdel(self) Returns: The UID of this property's delete function. (type=`UID`)

### _make_uid(self, func, cls, functype) Return a UID for the given fget/fset/fdel function of the property. This is a heuristic function, which first looks for the function within the current class (and its ancestors); and then looks for it as a module-level function. If the function is actually defined somewhere else (e.g., in an unrelated class), then it will be mistakenly interpreted as a module- level function. Parameters: `func` - The function to get a uid for. `cls` - The UID for the class containing the property.

### _process_field(self, tag, arg, descr, warnings) Process a field from this object's docstring. `ObjDoc._process_field` be overridden by child classes of `ObjDoc`, and called as the default case. Parameters: `tag` - The field's tag name (type=`string`) `arg` - The field's optional argument (or `None` if no argument was specified). (type=`string`) `descr` - The field's body. (type=`markup.ParsedDocstring`) `warnings` - A list of warnings that have been encountered. If any new warnings are encountered, then they should be appended to this list. Overrides: `epydoc.objdoc.ObjDoc._process_field` (inherited documentation)

Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004 | http://epydoc.sf.net