symbologyl2 package

Submodules

symbologyl2.lib.from_any_to_cms(symbol: str) → str

Returns the given symbol in CMS format.

>>> symbologyl2.from_any_to_cms('TEST')
'TEST'

>>> symbologyl2.from_any_to_cms('TEST A')
'TEST A'

>>> symbologyl2.from_any_to_cms('TEST.A')
'TEST A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The original symbol in CMS format
Return type: str

symbologyl2.lib.from_any_to_cms_suffix(symbol: str) → Optional[str]

Returns the given symbol suffix (if present) in CMS format, and None otherwise.

>>> symbologyl2.from_any_to_cms_suffix('TEST')

>>> symbologyl2.from_any_to_cms_suffix('TEST A')
'A'

>>> symbologyl2.from_any_to_cms_suffix('TEST.A')
'A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: suffix – The suffix in CMS format, or None if there is no suffix.
Return type: str or None

symbologyl2.lib.from_any_to_cqs(symbol: str) → str

Returns the given symbol in CQS format.

>>> symbologyl2.from_any_to_cqs('TEST')
'TEST'

>>> symbologyl2.from_any_to_cqs('TEST A')
'TEST.A'

>>> symbologyl2.from_any_to_cqs('TEST.A')
'TEST.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The original symbol in CQS format
Return type: str

symbologyl2.lib.from_any_to_cqs_suffix(symbol: str) → Optional[str]

Returns the given symbol suffix (if present) in CMS format, and None otherwise.

>>> symbologyl2.from_any_to_cqs_suffix('TEST')

>>> symbologyl2.from_any_to_cqs_suffix('TEST A')
'.A'

>>> symbologyl2.from_any_to_cqs_suffix('TEST.A')
'.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: suffix – The suffix in CQS format, or None if there is no suffix.
Return type: str or None

symbologyl2.lib.from_any_to_nasdaq_integrated(symbol: str) → str

Returns the given symbol in Nasdaq integrated format.

>>> symbologyl2.from_any_to_nasdaq_integrated('TEST')
'TEST'

>>> symbologyl2.from_any_to_nasdaq_integrated('TEST A')
'TEST.A'

>>> symbologyl2.from_any_to_nasdaq_integrated('TEST.A')
'TEST.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The original symbol in Nasdaq integrated format
Return type: str

symbologyl2.lib.from_any_to_nasdaq_suffix(symbol: str) → Optional[str]

Returns the given symbol suffix (if present) in Nasdaq integrated format, and None otherwise.

>>> symbologyl2.from_any_to_nasdaq_suffix('TEST')

>>> symbologyl2.from_any_to_nasdaq_suffix('TEST A')
'.A'

>>> symbologyl2.from_any_to_nasdaq_suffix('TEST.A')
'.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: suffix – The suffix in Nasdaq integrated format, or None if there is no suffix.
Return type: str or None

symbologyl2.lib.from_any_to_root(symbol: str) → str

Extracts the symbol root from an input string in CQS, CMS, or NASDAQ integrated symbology format.

>>> symbologyl2.from_any_to_root('TEST A')
'TEST'

>>> symbologyl2.from_any_to_root('TEST.A')
'TEST'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The symbol root
Return type: str

Wrapper lib for symbologyl2

symbologyl2.from_any_to_cms(symbol: str) → str

Returns the given symbol in CMS format.

>>> symbologyl2.from_any_to_cms('TEST')
'TEST'

>>> symbologyl2.from_any_to_cms('TEST A')
'TEST A'

>>> symbologyl2.from_any_to_cms('TEST.A')
'TEST A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The original symbol in CMS format
Return type: str

symbologyl2.from_any_to_cms_suffix(symbol: str) → Optional[str]

Returns the given symbol suffix (if present) in CMS format, and None otherwise.

>>> symbologyl2.from_any_to_cms_suffix('TEST')

>>> symbologyl2.from_any_to_cms_suffix('TEST A')
'A'

>>> symbologyl2.from_any_to_cms_suffix('TEST.A')
'A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: suffix – The suffix in CMS format, or None if there is no suffix.
Return type: str or None

symbologyl2.from_any_to_cqs(symbol: str) → str

Returns the given symbol in CQS format.

>>> symbologyl2.from_any_to_cqs('TEST')
'TEST'

>>> symbologyl2.from_any_to_cqs('TEST A')
'TEST.A'

>>> symbologyl2.from_any_to_cqs('TEST.A')
'TEST.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The original symbol in CQS format
Return type: str

symbologyl2.from_any_to_cqs_suffix(symbol: str) → Optional[str]

Returns the given symbol suffix (if present) in CMS format, and None otherwise.

>>> symbologyl2.from_any_to_cqs_suffix('TEST')

>>> symbologyl2.from_any_to_cqs_suffix('TEST A')
'.A'

>>> symbologyl2.from_any_to_cqs_suffix('TEST.A')
'.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: suffix – The suffix in CQS format, or None if there is no suffix.
Return type: str or None

symbologyl2.from_any_to_nasdaq_integrated(symbol: str) → str

Returns the given symbol in Nasdaq integrated format.

>>> symbologyl2.from_any_to_nasdaq_integrated('TEST')
'TEST'

>>> symbologyl2.from_any_to_nasdaq_integrated('TEST A')
'TEST.A'

>>> symbologyl2.from_any_to_nasdaq_integrated('TEST.A')
'TEST.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The original symbol in Nasdaq integrated format
Return type: str

symbologyl2.from_any_to_nasdaq_suffix(symbol: str) → Optional[str]

Returns the given symbol suffix (if present) in Nasdaq integrated format, and None otherwise.

>>> symbologyl2.from_any_to_nasdaq_suffix('TEST')

>>> symbologyl2.from_any_to_nasdaq_suffix('TEST A')
'.A'

>>> symbologyl2.from_any_to_nasdaq_suffix('TEST.A')
'.A'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: suffix – The suffix in Nasdaq integrated format, or None if there is no suffix.
Return type: str or None

symbologyl2.from_any_to_root(symbol: str) → str

Extracts the symbol root from an input string in CQS, CMS, or NASDAQ integrated symbology format.

>>> symbologyl2.from_any_to_root('TEST A')
'TEST'

>>> symbologyl2.from_any_to_root('TEST.A')
'TEST'

Parameters: symbol (str) – The input symbol, in CQS, CMS, or NASDAQ integrated symbology format
Returns: The symbol root
Return type: str