Disseminate

Document Processing

• Features: Basic
• Features: Advanced
• Quickstart

Installation

• MacOS (Homebrew)
• MacOS (Pip)
• Linux (Pip)

Markup Language

• Header
• Tags
• Macros

Projects

• Documents
• Templates

Interfaces

• Command-line

Development

• API Documentation
  • Attributes
  • Builders
  • Checkers
  • CLI
  • Contexts
  • Document
  • Formats
  • Label Manager
  • Paths
  • Server
  • Signals
  • Tags
  • Utilities
• Release Notes

• Index

Types

Generic types.

class disseminate.utils.types.FloatPositionalValue

Bases: disseminate.utils.types.PositionalValue

A placeholder for a positional float value in a dict.

class disseminate.utils.types.IntPositionalValue

Bases: disseminate.utils.types.PositionalValue

A placeholder for a positional integer value in a dict.

class disseminate.utils.types.PositionalValue

Bases: object

A placeholder for a positional value in a dict.

class disseminate.utils.types.StringPositionalValue

Bases: disseminate.utils.types.PositionalValue

A placeholder for a positional string value in a dict.

disseminate.utils.types.ispositional(p, positionalvalue_type=<class 'disseminate.utils.types.PositionalValue'>)

True, if the given parameter is a PositionalValue class or subclass.

Parameters

pobject

The parameter to test.

positionalvalue_typePositionalValue

The PositionalValue class to test whether parameter is a subclass of this type.

Returns

bool

True if parameter ‘p’ is the class or a subclass of PositonalValue (positionalvalue_type).

Examples

>>> ispositional('test')
False
>>> ispositional(IntPositionalValue)
True
>>> ispositional(PositionalValue)
True

disseminate.utils.types.positionalvalue_type(p)

Find the PostionalValue type for the given parameter.

Parameters

pobject

The parameter for which the PositionalValue class or subclass will be evaluated and returned.

Returns

positionalvalue_typePositionalValue

The PositionalValue class or subclass that matches the given parameter.

Examples

>>> positionalvalue_type(3)
<class 'disseminate.utils.types.IntPositionalValue'>
>>> positionalvalue_type('test')
<class 'disseminate.utils.types.StringPositionalValue'>
>>> positionalvalue_type('23')
<class 'disseminate.utils.types.IntPositionalValue'>
>>> positionalvalue_type('3.23')
<class 'disseminate.utils.types.FloatPositionalValue'>
>>> positionalvalue_type('src/media/image.png')
<class 'disseminate.utils.types.StringPositionalValue'>