adctk.debug_file_publisher.DebugFilePublisher Class Reference

debugging version of a file-oriented publisher. More...

Inheritance diagram for adctk.debug_file_publisher.DebugFilePublisher:

Collaboration diagram for adctk.debug_file_publisher.DebugFilePublisher:

Public Member Functions
	__init__ (self, path=None, **kwargs)
	post (self, j)
	publish (self, builder.Builder b)
	Publish json extracted from builder to _base_url server.
	publish_obj (self, obj)
	publish_str (self, json_string)
	config (self, **kwargs)
	Configure the plugin with the options given.
	initialize (self)
	Set up any resources needed for reuse in publish().
	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.

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

Protected Attributes
	_path

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)
Static Protected Attributes inherited from adctk.publisher.Publisher
str	_name = "unknown"
str	_version = "0.0.0"

Detailed Description

debugging version of a file-oriented publisher.

This assumes a single process writing to a given file and it has no evironment-based initialization. File is reopened for append on every publication. *** Do not use in production code. ***

Constructor & Destructor Documentation

__init__()

adctk.debug_file_publisher.DebugFilePublisher.__init__	(		self,
			path = None,
		**	kwargs
	)

Reimplemented from adctk.publisher.Publisher.

    def __init__(self, path=None, **kwargs):
        super().__init__()
        if not path:
            self.plugin_prefix = "ADC_DEBUG_FILE_PLUGIN_"
            self._path = self._get(kwargs, "FILE")
            if not self._path:
                self._path = "adc.debug_file_publisher.log"
        else:
            self._path = path
 

Member Function Documentation

config()

adctk.debug_file_publisher.DebugFilePublisher.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):
        pass # config: nothing to do here

finalize()

adctk.debug_file_publisher.DebugFilePublisher.finalize

(

self

)

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

Reimplemented from adctk.publisher.Publisher.

    def finalize(self):
        pass # finalize: nothing to do here

initialize()

adctk.debug_file_publisher.DebugFilePublisher.initialize

(

self

)

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

Reimplemented from adctk.publisher.Publisher.

    def initialize(self):
        pass # initialize: nothing to do here

post()

adctk.debug_file_publisher.DebugFilePublisher.post	(		self,
			j
	)

 log the message 

    def post(self, j):
        """ log the message """
        try:
            with open(self._path, mode="a", encoding='utf-8') as f:
                print(j, file=f)
                return 0
        except OSError as e:
            log.logger("error opening %s: %s", self._path, e)
            return 1
 

publish()

adctk.debug_file_publisher.DebugFilePublisher.publish	(		self,
		builder.Builder	b
	)

Publish json extracted from builder to _base_url server.

Reimplemented from adctk.publisher.Publisher.

    def publish(self, b: builder.Builder):
        """! Publish json extracted from builder to _base_url server"""
        ret = self.post(b.get_json_dump())
        return ret
 

publish_obj()

adctk.debug_file_publisher.DebugFilePublisher.publish_obj	(		self,
			obj
	)

publish obj (json.dumps(obj) result) from caller to file.
Does not produce valid ADCT messages.

Reimplemented from adctk.publisher.Publisher.

    def publish_obj(self, obj):
        """publish obj (json.dumps(obj) result) from caller to file.
        Does not produce valid ADCT messages.
        """
        ret = self.post(json.dumps(obj))
        return ret
 

publish_str()

adctk.debug_file_publisher.DebugFilePublisher.publish_str	(		self,
			json_string
	)

publish json_string (json.dumps result) from caller to file.
Does not produce valid ADCT messages.

Reimplemented from adctk.publisher.Publisher.

    def publish_str(self, json_string):
        """publish json_string (json.dumps result) from caller to file.
        Does not produce valid ADCT messages.
        """
        ret = self.post(json_string)
        return ret
 

Member Data Documentation

_path

adctk.debug_file_publisher.DebugFilePublisher._path

protected

plugin_prefix

adctk.debug_file_publisher.DebugFilePublisher.plugin_prefix

---

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

• src/adctk/debug_file_publisher.py