adctk.stdout_publisher.StdoutPublisher Class Reference

The console printing publisher. More...

Inheritance diagram for adctk.stdout_publisher.StdoutPublisher:

Collaboration diagram for adctk.stdout_publisher.StdoutPublisher:

Public Member Functions
	__init__ (self)
int	config (self, **kwargs)
	Configure the plugin with the options given.
int	initialize (self)
	Set up any resources needed for reuse in publish().
int	publish (self, builder.Builder b)
	Publish json extracted from builder.
None	finalize (self)
	Clean up any resources set up in initialize (files, pipes, etc).
Public Member Functions inherited from adctk.publisher.Publisher
str	name (self)
	Get the name which a factory or error message should use.
str	version (self)
dict[str, str]	get_option_defaults (self)
None	pause (self)
	Cause publish calls to be ignored until resume is called.
None	resume (self)
	Cancel an prior calls to pause.
int	publish_str (self, str json_string)
int	publish_obj (self, obj)

Public Attributes
	defaults
	plugin_prefix
	paused
	mode
Public Attributes inherited from adctk.publisher.Publisher
	defaults
	plugin_prefix
	paused
	state
	mode

Static Protected Attributes
str	_name = "stdout"
str	_version = "1.0.0"
Static Protected Attributes inherited from adctk.publisher.Publisher
str	_name = "unknown"
str	_version = "0.0.0"

Additional Inherited Members
Static Public Member Functions inherited from adctk.publisher.Publisher
tuple[float]	get_timeout_defaults ()
	Get the adc server connect and response timeouts defined in the environment ADC_SERVER_CONNECT_TIMEOUT and ADC_SERVER_POST_TIMEOUT as a tuple or default values if not defined.
str	get_url_default ()
	Get the alleged adc server url base from environment ADC_SERVER_URL or the default if it is not present.
str	get_port_default ()
	Get the adc server port number to use if it is properly defined in the environment ADC_SERVER_PORT or the default if it is not.
Static Public Attributes inherited from adctk.publisher.Publisher
	API_VERSION = adc_version.AdcVersion()._dict()
Protected Member Functions inherited from adctk.publisher.Publisher
str	_get (self, dict[str, str] opts, str field)
bool	_get_bool (self, dict[str, str] opts, str field)

Detailed Description

The console printing publisher.

No environment variables.

Constructor & Destructor Documentation

__init__()

adctk.stdout_publisher.StdoutPublisher.__init__

(

self

)

Reimplemented from adctk.publisher.Publisher.

    def __init__(self):
        super().__init__()
        self.defaults = None
        self.plugin_prefix = "ADC_STDOUT_PLUGIN_"
        self.paused = False
        self.mode = publisher.Publisher.Mode.PUB_OR_FINAL
 

Member Function Documentation

config()

int adctk.stdout_publisher.StdoutPublisher.config	(		self,
		**	kwargs
	)

Configure the plugin with the options given.

For plugin QQQ, Environment variables ADC_QQQ_PLUGIN_<key> will override the plugin default for any key not defined in kwargs. Here QQQ is plugin.name().upper(). Generic options:

Parameters

kwargs	If env_prefix is included in kwargs, replaces plugin environment variables with those which are prefixed using env_prefix.
env_prefix	Typically, env_prefix is set to "PPP_ADC_QQQ_PLUGIN_" if application PPP wants to override the defaults of adctk plugin QQQ. Here QQQ is plugin.name().upper(). If no prefixed version of the variable is present, the plugin default is used. kwargs takes precedence over environment variables. Plugin defaults are used if not overridden by kwargs or an environment variable.

Returns

int non-zero if configuration cannot be completed using the arguments, environment, and default.

Reimplemented from adctk.publisher.Publisher.

    def config(self, **kwargs) -> int:
        return 0
 

finalize()

None adctk.stdout_publisher.StdoutPublisher.finalize

(

self

)

Clean up any resources set up in initialize (files, pipes, etc).

Reimplemented from adctk.publisher.Publisher.

    def finalize(self) -> None:
        return None

initialize()

int adctk.stdout_publisher.StdoutPublisher.initialize

(

self

)

Set up any resources needed for reuse in publish().

Reimplemented from adctk.publisher.Publisher.

    def initialize(self) -> int:
        return 0
 

publish()

int adctk.stdout_publisher.StdoutPublisher.publish	(		self,
		builder.Builder	b
	)

Publish json extracted from builder.

Reimplemented from adctk.publisher.Publisher.

    def publish(self, b: builder.Builder) -> int:
        if self.paused:
            return 0
        print(b.serialize())
        return 0
 

Member Data Documentation

_name

str adctk.stdout_publisher.StdoutPublisher._name = "stdout"

staticprotected

_version

str adctk.stdout_publisher.StdoutPublisher._version = "1.0.0"

staticprotected

defaults

adctk.stdout_publisher.StdoutPublisher.defaults

mode

adctk.stdout_publisher.StdoutPublisher.mode

paused

adctk.stdout_publisher.StdoutPublisher.paused

plugin_prefix

adctk.stdout_publisher.StdoutPublisher.plugin_prefix

---

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

• src/adctk/stdout_publisher.py