Share and Money Management 0.18devel
Static Public Attributes | Static Private Attributes | List of all members
smm.quote.base.FetchPluginBase Class Reference

Base class of all quotation classes. More...

Inheritance diagram for smm.quote.base.FetchPluginBase:

Static Public Attributes

list properties = []
 List of supported properties. More...
 
bool check_robotfile = True
 Check and respect the robots.txt file. More...
 
bool active = True
 Set False to deactivate a plugin. More...
 
int interface_version = 2
 Version number of the interface to access and convert the data. More...
 
string logger_name = "smm.quote.base"
 Name of the instance logger. More...
 
string name = "Override in derivated class!"
 Name of the data source. More...
 
 provider_id = None
 Unique provider ID. More...
 
string dsep = ","
 Decimal separator for converting strings to decimal values. More...
 
 tsep = None
 Thousands separator for converting strings to decimal values. More...
 
 logger = None
 Instance logger. More...
 
int max_retries = 3
 Number of retries for temporary connection errors. More...
 
tuple user_agent
 Define an own user agent string. More...
 

Static Private Attributes

list _specific_properties = []
 Property names. More...
 
list _general_properties = ["errormsg", "success"]
 Name of the general properties. More...
 

Detailed Description

Base class of all quotation classes.

This class provides often used functions e.g. to access remote resources or to convert date and time from strings into Python objects.

Member Data Documentation

◆ _general_properties

list smm.quote.base.FetchPluginBase._general_properties = ["errormsg", "success"]
staticprivate

Name of the general properties.

◆ _specific_properties

list smm.quote.base.FetchPluginBase._specific_properties = []
staticprivate

Property names.

◆ active

bool smm.quote.base.FetchPluginBase.active = True
static

Set False to deactivate a plugin.

◆ check_robotfile

bool smm.quote.base.FetchPluginBase.check_robotfile = True
static

Check and respect the robots.txt file.

◆ dsep

string smm.quote.base.FetchPluginBase.dsep = ","
static

Decimal separator for converting strings to decimal values.

See also
attr2decimal()
tsep

◆ interface_version

int smm.quote.base.FetchPluginBase.interface_version = 2
static

Version number of the interface to access and convert the data.

◆ logger

smm.quote.base.FetchPluginBase.logger = None
static

◆ logger_name

string smm.quote.base.FetchPluginBase.logger_name = "smm.quote.base"
static

Name of the instance logger.

◆ max_retries

int smm.quote.base.FetchPluginBase.max_retries = 3
static

Number of retries for temporary connection errors.

See also
wait

◆ name

string smm.quote.base.FetchPluginBase.name = "Override in derivated class!"
static

◆ properties

list smm.quote.base.FetchPluginBase.properties = []
static

List of supported properties.

Every class should provide a minimum set of properties

  • date Time tuple with the date and time (if available) of the quote
  • errormsg As unicode string or None
  • quote.price As ascii string
  • source Source of the data as unicode string
  • success Flag as boolean value

Referenced by smm.quote.yahoo.YahooCSVFetchPlugin.__init__().

◆ provider_id

smm.quote.base.FetchPluginBase.provider_id = None
static

Unique provider ID.

◆ tsep

smm.quote.base.FetchPluginBase.tsep = None
static

Thousands separator for converting strings to decimal values.

See also
attr2decimal()
dsep

◆ user_agent

tuple smm.quote.base.FetchPluginBase.user_agent
static
Initial value:
= (
"Mozilla/5.0 (X11; U; Linux i686; de; rv:1.9.1.6) Gecko/20091201 Firefox/3.5.6"
)

Define an own user agent string.

Set to None for disable changing user agent


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