pipolars.RetrievalMode - PIPolars 0.1.0 documentation

Skip to content
Back to top
View this page
Edit this page

# pipolars.RetrievalMode

class pipolars.RetrievalMode

  Bases: `str`, `Enum`

  Data retrieval modes for PI Point queries.

  These modes determine how data is retrieved from the PI Data Archive.

  __init__(*args, **kwds)

  Methods

  `encode`([encoding, errors]) | Encode the string using the codec registered for encoding.
  `replace`(old, new, /[, count]) | Return a copy with all occurrences of substring old replaced by new.
  `split`([sep, maxsplit]) | Return a list of the substrings in the string, using sep as the separator string.
  `rsplit`([sep, maxsplit]) | Return a list of the substrings in the string, using sep as the separator string.
  `join`(iterable, /) | Concatenate any number of strings.
  `capitalize`() | Return a capitalized version of the string.
  `casefold`() | Return a version of the string suitable for caseless comparisons.
  `title`() | Return a version of the string where each word is titlecased.
  `center`(width[, fillchar]) | Return a centered string of length width.
  `count` | Return the number of non-overlapping occurrences of substring sub in string S[start:end].
  `expandtabs`([tabsize]) | Return a copy where all tab characters are expanded using spaces.
  `find` | Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].
  `partition`(sep, /) | Partition the string into three parts using the given separator.
  `index` | Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].
  `ljust`(width[, fillchar]) | Return a left-justified string of length width.
  `lower`() | Return a copy of the string converted to lowercase.
  `lstrip`([chars]) | Return a copy of the string with leading whitespace removed.
  `rfind` | Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].
  `rindex` | Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].
  `rjust`(width[, fillchar]) | Return a right-justified string of length width.
  `rstrip`([chars]) | Return a copy of the string with trailing whitespace removed.
  `rpartition`(sep, /) | Partition the string into three parts using the given separator.
  `splitlines`([keepends]) | Return a list of the lines in the string, breaking at line boundaries.
  `strip`([chars]) | Return a copy of the string with leading and trailing whitespace removed.
  `swapcase`() | Convert uppercase characters to lowercase and lowercase characters to uppercase.
  `translate`(table, /) | Replace each character in the string using the given translation table.
  `upper`() | Return a copy of the string converted to uppercase.
  `startswith` | Return True if the string starts with the specified prefix, False otherwise.
  `endswith` | Return True if the string ends with the specified suffix, False otherwise.
  `removeprefix`(prefix, /) | Return a str with the given prefix string removed if present.
  `removesuffix`(suffix, /) | Return a str with the given suffix string removed if present.
  `isascii`() | Return True if all characters in the string are ASCII, False otherwise.
  `islower`() | Return True if the string is a lowercase string, False otherwise.
  `isupper`() | Return True if the string is an uppercase string, False otherwise.
  `istitle`() | Return True if the string is a title-cased string, False otherwise.
  `isspace`() | Return True if the string is a whitespace string, False otherwise.
  `isdecimal`() | Return True if the string is a decimal string, False otherwise.
  `isdigit`() | Return True if the string is a digit string, False otherwise.
  `isnumeric`() | Return True if the string is a numeric string, False otherwise.
  `isalpha`() | Return True if the string is an alphabetic string, False otherwise.
  `isalnum`() | Return True if the string is an alpha-numeric string, False otherwise.
  `isidentifier`() | Return True if the string is a valid Python identifier, False otherwise.
  `isprintable`() | Return True if all characters in the string are printable, False otherwise.
  `zfill`(width, /) | Pad a numeric string with zeros on the left, to fill a field of the given width.
  `format`(*args, **kwargs) | Return a formatted version of the string, using substitutions from args and kwargs.
  `format_map`(mapping, /) | Return a formatted version of the string, using substitutions from mapping.
  `maketrans` | Return a translation table usable for str.translate().
  `__init__`(*args, **kwds) |

  Attributes

  `RECORDED` | Return actual recorded values as stored in the archive.
  `INTERPOLATED` | Return interpolated values at regular intervals.
  `PLOT` | Return values optimized for plotting (reduced data density).
  `SUMMARY` | Return summary statistics (min, max, avg, etc.).
  `COMPRESSED` | Return compressed data using exception/compression settings.

  RECORDED = 'recorded'

    Return actual recorded values as stored in the archive.

  INTERPOLATED = 'interpolated'

    Return interpolated values at regular intervals.

  PLOT = 'plot'

    Return values optimized for plotting (reduced data density).

  SUMMARY = 'summary'

    Return summary statistics (min, max, avg, etc.).

  COMPRESSED = 'compressed'

    Return compressed data using exception/compression settings.

  __new__(value)