IndexYearGO¶

class IndexYearGO(labels: Union[IndexBase, Iterable[Hashable], Iterable[Sequence[Hashable]]], *, name: Optional[Hashable] = <object object>)[source]¶

IndexYearGO: Constructor¶

IndexYearGO.__init__(labels: Union[IndexBase, Iterable[Hashable], Iterable[Sequence[Hashable]]], *, name: Optional[Hashable] = <object object>)

Initializer.

Parameters

labels – Iterable of hashable values to be used as the index labels. If strings, NumPy datetime conversions will be applied.
name – A hashable object to label the container.

classmethod IndexYearGO.from_date_range(start: Union[str, datetime.date, numpy.datetime64], stop: Union[str, datetime.date, numpy.datetime64], step: int = 1, *, name: Optional[Hashable] = None) → I: Get an IndexYearMonth instance over a range of dates, where start and stop are inclusive.

classmethod IndexYearGO.from_labels(labels: Iterable[Sequence[Hashable]], *, name: Optional[Hashable] = None) → I: Construct an Index from an iterable of labels, where each label is a hashable. Provided for a compatible interface to IndexHierarchy.

classmethod IndexYearGO.from_pandas(value: pandas.Index) → IndexBase: Given a Pandas index, return the appropriate IndexBase derived class.

classmethod IndexYearGO.from_year_month_range(start: Union[str, datetime.date, numpy.datetime64], stop: Union[str, datetime.date, numpy.datetime64], step: int = 1, *, name: Optional[Hashable] = None) → I: Get an IndexYearMonth instance over a range of months, where start and end are inclusive.

classmethod IndexYearGO.from_year_range(start: Union[str, datetime.date, numpy.datetime64], stop: Union[str, datetime.date, numpy.datetime64], step: int = 1, *, name: Optional[Hashable] = None) → I: Get an IndexDate instance over a range of years, where start and end are inclusive.

IndexYearGO: Exporter¶

Overview: IndexYearGO: Exporter

IndexYearGO.to_html(config: Optional[static_frame.core.display_config.DisplayConfig] = None, style_config: Optional[static_frame.core.style_config.StyleConfig] = <static_frame.core.style_config.StyleConfig object>) → str

Return an HTML table representation of this Index using standard TABLE, TR, and TD tags. This is not a complete HTML page.

Parameters: config – Optional DisplayConfig instance.
Returns: str

IndexYearGO.to_html_datatables(fp: Optional[Union[str, os.PathLike, TextIO]] = None, *, show: bool = True, config: Optional[static_frame.core.display_config.DisplayConfig] = None) → Optional[str]

Return a complete HTML representation of this Index using the DataTables JS library for table naviagation and search. The page links to CDNs for JS resources, and thus will not fully render without an internet connection.

Parameters

fp – optional file path to write; if not provided, a temporary file will be created. Note: the caller is responsible for deleting this file.
show – if True, the file will be opened with a webbrowser.
config – Optional DisplayConfig instance.

Returns

str, absolute file path to the file written.

IndexYearGO.to_pandas() → None: Return a Pandas Index.

IndexYearGO.to_series() → Series: Return a Series with values from this Index’s labels.

IndexYearGO.to_visidata() → None: Open an interactive VisiData session.

IndexYearGO: Attribute¶

Overview: IndexYearGO: Attribute

IndexYearGO.STATIC: bool = False

IndexYearGO.depth: int = 1

IndexYearGO.dtype: np.dtype

Return the dtype of the underlying NumPy array.

Returns: numpy.dtype

IndexYearGO.mloc: The memory location, represented as an integer, of the underlying NumPy array.

IndexYearGO.name

A hashable label attached to this container.

Returns: Hashable

IndexYearGO.names: Provide a suitable iterable of names for usage in output formats that require a field name as string for the index.

IndexYearGO.nbytes

Return the total bytes of the underlying NumPy array.

Returns: int

IndexYearGO.ndim

Return the number of dimensions.

Returns: int

IndexYearGO.positions: np.ndarray: Return the immutable positions array.

IndexYearGO.shape

Return a tuple describing the shape of the underlying NumPy array.

Returns: tp.Tuple[int]

IndexYearGO.size

Return the size of the underlying NumPy array.

Returns: int

IndexYearGO: Method¶

Overview: IndexYearGO: Method

IndexYearGO.__bool__() → bool: Raises ValueError to prohibit ambiguous use of truethy evaluation.

IndexYearGO.__copy__() → I: Return shallow copy of this Index.

IndexYearGO.__deepcopy__(memo: Dict[int, Any]) → I

IndexYearGO.__len__() → int

IndexYearGO.all(axis: int = 0, skipna: bool = True, out: Optional[numpy.ndarray] = None) → Any

Logical and over values along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.any(axis: int = 0, skipna: bool = True, out: Optional[numpy.ndarray] = None) → Any

Logical or over values along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.append(value: Hashable) → None: Specialize for fixed-typed indices: convert value argument; do not need to resolve_dtype with each addition; self._map is never None

IndexYearGO.astype(dtype: Optional[Union[str, numpy.dtype, type]]) → static_frame.core.index.Index

Return an Index with type determined by dtype argument. Note that for Index, this is a simple function, whereas for IndexHierarchy, this is an interface exposing both a callable and a getitem interface.

Parameters: dtype – A value suitable for specyfying a NumPy dtype, such as a Python type (float), NumPy array protocol strings (‘f8’), or a dtype instance.

IndexYearGO.copy() → I: Return shallow copy of this Index.

IndexYearGO.cumprod(axis: int = 0, skipna: bool = True) → Any

Return the cumulative product over the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.cumsum(axis: int = 0, skipna: bool = True) → Any

Return the cumulative sum over the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.difference(other: Union[static_frame.core.index_base.IndexBase, Iterable[Hashable]]) → I: Perform difference with another Index, container, or NumPy array. Retains order.

IndexYearGO.equals(other: Any, *, compare_name: bool = False, compare_dtype: bool = False, compare_class: bool = False, skipna: bool = True) → bool

Return a bool from comparison to any other object.

Parameters

compare_name – Include equality of the container’s name (and all composed containers) in the comparison.
compare_dtype – Include equality of the container’s dtype (and all composed containers) in the comparison.
compare_class – Include equality of the container’s class (and all composed containers) in the comparison.
skipna – If True, comparisons between missing values are equal.

IndexYearGO.extend(values: Union[Iterable[Any], numpy.ndarray]) → None: Append multiple values :param values: can be a generator.

IndexYearGO.fillna(value: Any) → static_frame.core.index.Index

Return an Index with replacing null (NaN or None) with the supplied value.

Parameters: value – Value to be used to replace missing values (NaN or None).

IndexYearGO.head(count: int = 5) → I

Return a Index consisting only of the top elements as specified by count.

Parameters: count – Number of elements to be returned from the top of the Index

IndexYearGO.iloc_searchsorted(values: Any, *, side_left: bool = True) → Union[Hashable, Iterable[Hashable]]

Given a sorted Series, return the iloc (integer) position(s) at which insertion in values would retain sort order.

Parameters

values – a single value, or iterable of values.
side_left – If True, the index of the first suitable location found is given, else return the last such index. If matching an existing value, side_left==True will return that position, side_left==Right will return the next position (or the length).

IndexYearGO.intersection(*others: Union[static_frame.core.index_base.IndexBase, Iterable[Hashable]]) → I: Perform intersection with one or many Index, container, or NumPy array. Identical comparisons retain order.

IndexYearGO.isin(other: Iterable[Any]) → numpy.ndarray: Return a Boolean array showing True where a label is found in other. If other is a multidimensional array, it is flattened.

IndexYearGO.label_widths_at_depth(depth_level: Union[int, Iterable[int]] = 0) → Iterator[Tuple[Hashable, int]]

A generator of pairs, where each pair is the label and the count of that label found at the depth specified by depth_level.

Parameters: depth_level – a depth level, starting from zero.

IndexYearGO.level_add(level: Hashable) → IndexHierarchy: Return an IndexHierarchy with an added root level.

IndexYearGO.loc_searchsorted(values: Any, *, side_left: bool = True, fill_value: Any = nan) → Union[Hashable, Iterable[Hashable]]

Given a sorted Series, return the loc (label) position(s) at which insertion in values would retain sort order.

Parameters

values – a single value, or iterable of values.
side_left – If True, the index of the first suitable location found is given, else return the last such index. If matching an existing value, side_left==True will return that position, side_left==Right will return the next position (or the length).
fill_value – A value to be used to fill the label beyond the last label.

IndexYearGO.loc_to_iloc(key: Union[int, numpy.integer, slice, List[Any], None, Index, Series, numpy.ndarray]) → Union[int, numpy.integer, slice, List[Any], None, Index, Series, numpy.ndarray]

Given a label (loc) style key (either a label, a list of labels, a slice, or a Boolean selection), return the index position (iloc) style key. Keys that are not found will raise a KeyError or a sf.LocInvalid error.

Parameters: key – a label key.

IndexYearGO.max(axis: int = 0, skipna: bool = True) → Any

Return the maximum along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.mean(axis: int = 0, skipna: bool = True, out: Optional[numpy.ndarray] = None) → Any

Return the mean along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.median(axis: int = 0, skipna: bool = True, out: Optional[numpy.ndarray] = None) → Any

Return the median along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.min(axis: int = 0, skipna: bool = True, out: Optional[numpy.ndarray] = None) → Any

Return the minimum along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.prod(axis: int = 0, skipna: bool = True, out: Optional[numpy.ndarray] = None) → Any

Return the product along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.relabel(mapper: RelabelInput) → Index: Return a new Index with labels replaced by the callable or mapping; order will be retained. If a mapping is used, the mapping need not map all origin keys.

IndexYearGO.rename(name: Optional[Hashable]) → I: Return a new Frame with an updated name attribute.

IndexYearGO.roll(shift: int) → static_frame.core.index.Index: Return an Index with values rotated forward and wrapped around (with a postive shift) or backward and wrapped around (with a negative shift).

IndexYearGO.sample(count: int = 1, *, seed: Optional[int] = None) → I

Randomly (optionally made deterministic with a fixed seed) extract items from the container to return a subset of the container.

Parameters

of elements to select. (Number) –
state of random selection. (Initial) –

IndexYearGO.sort(ascending: bool = True, kind: str = 'mergesort', key: Optional[Callable[[static_frame.core.index.Index], Union[numpy.ndarray, static_frame.core.index.Index]]] = None) → static_frame.core.index.Index

Return a new Index with the labels sorted.

Parameters

ascending – If True, sort in ascending order; if False, sort in descending order.
kind – Name of the sort algorithm as passed to NumPy.
key – A function that is used to pre-process the selected columns or rows and derive new values to sort by.

IndexYearGO.std(axis: int = 0, skipna: bool = True, ddof: int = 0, out: Optional[numpy.ndarray] = None) → Any

Return the standard deviaton along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.sum(axis: int = 0, skipna: bool = True, out: Optional[numpy.ndarray] = None) → Any

Sum values along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO.tail(count: int = 5) → I

Return a Index consisting only of the bottom elements as specified by count.

Parameters: count – Number of elements to be returned from the bottom of the Index

IndexYearGO.union(*others: Union[static_frame.core.index_base.IndexBase, Iterable[Hashable]]) → I: Perform union with another Index, container, or NumPy array. Identical comparisons retain order.

IndexYearGO.unique(depth_level: Union[int, Iterable[int]] = 0) → numpy.ndarray

Return a NumPy array of unique values.

Parameters: depth_level – defaults to 0 for for a 1D Index.
Returns: numpy.ndarray

IndexYearGO.values_at_depth(depth_level: Union[int, Iterable[int]] = 0) → numpy.ndarray: Return an NP array for the depth_level specified.

IndexYearGO.var(axis: int = 0, skipna: bool = True, ddof: int = 0, out: Optional[numpy.ndarray] = None) → Any

Return the variance along the specified axis.

Parameters

axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.

IndexYearGO: Dictionary-Like¶

Overview: IndexYearGO: Dictionary-Like

IndexYearGO.__contains__(value: Any) → bool: Return True if value in the labels. Will only return True for an exact match to the type of dates stored within.

IndexYearGO.__iter__() → Iterator[Hashable]: Iterate over labels.

IndexYearGO.__reversed__() → Iterator[Hashable]: Returns a reverse iterator on the index labels.

IndexYearGO.values: np.ndarray: A 1D NumPy array of the values in the Index. This array will have the same dtype as the container.

IndexYearGO: Display¶

Overview: IndexYearGO: Display

IndexYearGO.interface¶

A Frame documenting the interface of this class.

>>> sf.IndexYearGO.interface.loc[sf.IndexYearGO.interface.index.via_str.startswith('from_')]
<Frame: IndexYearGO>
<Index>                              cls_name    group       doc                  <<U18>
<Index: signature>
from_date_range(start, stop, step... IndexYearGO Constructor Get an IndexYearM...
from_labels(labels, *, name)         IndexYearGO Constructor Construct an Inde...
from_pandas(value)                   IndexYearGO Constructor Given a Pandas in...
from_year_month_range(start, stop... IndexYearGO Constructor Get an IndexYearM...
from_year_range(start, stop, step... IndexYearGO Constructor Get an IndexDate ...
<<U68>                               <<U11>      <<U27>      <<U83>

IndexYearGO.__repr__() → str: Return repr(self).

IndexYearGO.__str__(): Return str(self).

IndexYearGO.display(config: Optional[static_frame.core.display_config.DisplayConfig] = None, *, style_config: Optional[static_frame.core.style_config.StyleConfig] = None) → static_frame.core.display.Display

Return a static_frame.Display, capable of providing a string representation.

Parameters: config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

IndexYearGO.display_tall(config: Optional[static_frame.core.display_config.DisplayConfig] = None) → static_frame.core.display.Display

Maximize vertical presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters: config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

IndexYearGO.display_wide(config: Optional[static_frame.core.display_config.DisplayConfig] = None) → static_frame.core.display.Display

Maximize horizontal presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters: config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

IndexYearGO: Selector¶

Overview: IndexYearGO: Selector

IndexYearGO.drop.iloc[key]

IndexYearGO.drop

InterfaceSelectDuo.iloc

IndexYearGO.drop.loc[key]

IndexYearGO.drop

InterfaceSelectDuo.loc

IndexYearGO[key]

IndexYearGO.__getitem__ = <function Index.__getitem__>

IndexYearGO.iloc[key]

IndexYearGO.iloc: tp.Any

IndexYearGO.loc[key]

IndexYearGO.loc: tp.Any

IndexYearGO: Iterator¶

Overview: IndexYearGO: Iterator

IndexYearGO.iter_label(depth_level)

iter_label

IndexYearGO.iter_label(depth_level).apply(func, *, dtype, name)

iter_label

IterNodeDelegate.apply(func: Callable[[…], Any], *, dtype: Optional[Union[str, numpy.dtype, type]] = None, name: Optional[Hashable] = None) → FrameOrSeries[source]

Apply a function to each value. Returns a new container.

Parameters

func – A function that takes a value.
dtype – A value suitable for specyfying a NumPy dtype, such as a Python type (float), NumPy array protocol strings (‘f8’), or a dtype instance.

IndexYearGO.iter_label(depth_level).apply_iter(func)

iter_label

IterNodeDelegate.apply_iter(func: Callable[[…], Any]) → Iterator[Any][source]

Apply a function to each value. A generator of resulting values.

Parameters: func – A function that takes a value.

IndexYearGO.iter_label(depth_level).apply_iter_items(func)

iter_label

IterNodeDelegate.apply_iter_items(func: Callable[[…], Any]) → Iterator[Tuple[Any, Any]][source]

Apply a function to each value. A generator of resulting key, value pairs.

Parameters: func – A function that takes a value.

IndexYearGO.iter_label(depth_level).apply_pool(func, *, dtype, name, max_workers, chunksize, use_threads)

iter_label

IterNodeDelegate.apply_pool(func: Callable[[…], Any], *, dtype: Optional[Union[str, numpy.dtype, type]] = None, name: Optional[Hashable] = None, max_workers: Optional[int] = None, chunksize: int = 1, use_threads: bool = False) → FrameOrSeries[source]

Apply a function to each value. Employ parallel processing with either the ProcessPoolExecutor or ThreadPoolExecutor.

Parameters

func – A function that takes a value.
* –
dtype – A value suitable for specyfying a NumPy dtype, such as a Python type (float), NumPy array protocol strings (‘f8’), or a dtype instance.
name – A hashable object to label the container.
max_workers – Number of parallel executors, as passed to the Thread- or ProcessPoolExecutor; None defaults to the max number of machine processes.
chunksize – Units of work per executor, as passed to the Thread- or ProcessPoolExecutor.
use_threads – Use the ThreadPoolExecutor instead of the ProcessPoolExecutor.

IndexYearGO.iter_label(depth_level).map_all(mapping, *, dtype, name)

iter_label

IterNodeDelegate.map_all(mapping: Union[Mapping[Hashable, Any], Series], *, dtype: Optional[Union[str, numpy.dtype, type]] = None, name: Optional[Hashable] = None) → FrameOrSeries[source]

Apply a mapping; for values not in the mapping, an Exception is raised. Returns a new container.

Parameters

mapping – A mapping type, such as a dictionary or Series.
dtype – A value suitable for specyfying a NumPy dtype, such as a Python type (float), NumPy array protocol strings (‘f8’), or a dtype instance.

IndexYearGO.iter_label(depth_level).map_all_iter(mapping)

iter_label

IterNodeDelegate.map_all_iter(mapping: Union[Mapping[Hashable, Any], Series]) → Iterator[Any][source]

Apply a mapping; for values not in the mapping, an Exception is raised. A generator of resulting values.

Parameters: mapping – A mapping type, such as a dictionary or Series.

IndexYearGO.iter_label(depth_level).map_all_iter_items(mapping)

iter_label

IterNodeDelegate.map_all_iter_items(mapping: Union[Mapping[Hashable, Any], Series]) → Iterator[Tuple[Any, Any]][source]

Apply a mapping; for values not in the mapping, an Exception is raised. A generator of resulting key, value pairs.

Parameters: mapping – A mapping type, such as a dictionary or Series.

IndexYearGO.iter_label(depth_level).map_any(mapping, *, dtype, name)

iter_label

IterNodeDelegate.map_any(mapping: Union[Mapping[Hashable, Any], Series], *, dtype: Optional[Union[str, numpy.dtype, type]] = None, name: Optional[Hashable] = None) → FrameOrSeries[source]

Apply a mapping; for values not in the mapping, the value is returned. Returns a new container.

Parameters

mapping – A mapping type, such as a dictionary or Series.
dtype – A value suitable for specyfying a NumPy dtype, such as a Python type (float), NumPy array protocol strings (‘f8’), or a dtype instance.

IndexYearGO.iter_label(depth_level).map_any_iter(mapping)

iter_label

IterNodeDelegate.map_any_iter(mapping: Union[Mapping[Hashable, Any], Series]) → Iterator[Any][source]

Apply a mapping; for values not in the mapping, the value is returned. A generator of resulting values.

Parameters: mapping – A mapping type, such as a dictionary or Series.

IndexYearGO.iter_label(depth_level).map_any_iter_items(mapping)

iter_label

IterNodeDelegate.map_any_iter_items(mapping: Union[Mapping[Hashable, Any], Series]) → Iterator[Tuple[Any, Any]][source]

Apply a mapping; for values not in the mapping, the value is returned. A generator of resulting key, value pairs.

Parameters: mapping – A mapping type, such as a dictionary or Series.

IndexYearGO.iter_label(depth_level).map_fill(mapping, *, fill_value, dtype, name)

iter_label

IterNodeDelegate.map_fill(mapping: Union[Mapping[Hashable, Any], Series], *, fill_value: Any = nan, dtype: Optional[Union[str, numpy.dtype, type]] = None, name: Optional[Hashable] = None) → FrameOrSeries[source]

Apply a mapping; for values not in the mapping, the fill_value is returned. Returns a new container.

Parameters

mapping – A mapping type, such as a dictionary or Series.
fill_value – Value to be returned if the values is not a key in the mapping.
dtype – A value suitable for specyfying a NumPy dtype, such as a Python type (float), NumPy array protocol strings (‘f8’), or a dtype instance.

IndexYearGO.iter_label(depth_level).map_fill_iter(mapping, *, fill_value)

iter_label

IterNodeDelegate.map_fill_iter(mapping: Union[Mapping[Hashable, Any], Series], *, fill_value: Any = nan) → Iterator[Any][source]

Apply a mapping; for values not in the mapping, the fill_value is returned. A generator of resulting values.

Parameters

mapping – A mapping type, such as a dictionary or Series.
fill_value – Value to be returned if the values is not a key in the mapping.

IndexYearGO.iter_label(depth_level).map_fill_iter_items(mapping, *, fill_value)

iter_label

IterNodeDelegate.map_fill_iter_items(mapping: Union[Mapping[Hashable, Any], Series], *, fill_value: Any = nan) → Iterator[Tuple[Any, Any]][source]

Apply a mapping; for values not in the mapping, the fill_value is returned. A generator of resulting key, value pairs.

Parameters

mapping – A mapping type, such as a dictionary or Series.
fill_value – Value to be returned if the values is not a key in the mapping.

IndexYearGO: Operator Binary¶

Overview: IndexYearGO: Operator Binary

IndexYearGO.__add__(other: Any) → Any

IndexYearGO.__and__(other: Any) → Any

IndexYearGO.__eq__(other: Any) → Any: Return self==value.

IndexYearGO.__floordiv__(other: Any) → Any

IndexYearGO.__ge__(other: Any) → Any: Return self>=value.

IndexYearGO.__gt__(other: Any) → Any: Return self>value.

IndexYearGO.__le__(other: Any) → Any: Return self<=value.

IndexYearGO.__lt__(other: Any) → Any: Return self<value.

IndexYearGO.__matmul__(other: Any) → Any

IndexYearGO.__mod__(other: Any) → Any

IndexYearGO.__mul__(other: Any) → Any

IndexYearGO.__ne__(other: Any) → Any: Return self!=value.

IndexYearGO.__or__(other: Any) → Any

IndexYearGO.__pow__(other: Any) → Any

IndexYearGO.__radd__(other: Any) → Any

IndexYearGO.__rfloordiv__(other: Any) → Any

IndexYearGO.__rmatmul__(other: Any) → Any

IndexYearGO.__rmul__(other: Any) → Any

IndexYearGO.__rshift__(other: Any) → Any

IndexYearGO.__rsub__(other: Any) → Any

IndexYearGO.__rtruediv__(other: Any) → Any

IndexYearGO.__sub__(other: Any) → Any

IndexYearGO.__truediv__(other: Any) → Any

IndexYearGO.__xor__(other: Any) → Any

IndexYearGO: Operator Unary¶

Overview: IndexYearGO: Operator Unary

IndexYearGO.__abs__() → static_frame.core.container.ContainerOperand

IndexYearGO.__invert__() → static_frame.core.container.ContainerOperand

IndexYearGO.__neg__() → static_frame.core.container.ContainerOperand

IndexYearGO.__pos__() → static_frame.core.container.ContainerOperand

IndexYearGO: Accessor Datetime¶

Overview: IndexYearGO: Accessor Datetime

IndexYearGO.via_dt.year

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.year: Return the year of each element.

IndexYearGO.via_dt.month

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.month: Return the month of each element, between 1 and 12 inclusive.

IndexYearGO.via_dt.day

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.day: Return the day of each element, between 1 and the number of days in the given month of the given year.

IndexYearGO.via_dt.weekday

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.weekday() → TContainer[source]: Return the day of the week as an integer, where Monday is 0 and Sunday is 6.

IndexYearGO.via_dt.timetuple

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.timetuple() → TContainer[source]: Return a time.struct_time such as returned by time.localtime().

IndexYearGO.via_dt.fromisoformat

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.fromisoformat() → TContainer[source]: Return a datetime.date object from an ISO 8601 format.

IndexYearGO.via_dt.isoformat(sep, timespec)

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.isoformat(sep: str = 'T', timespec: str = 'auto') → TContainer[source]: Return a string representing the date in ISO 8601 format, YYYY-MM-DD.

IndexYearGO.via_dt.strftime(format)

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.strftime(format: str) → TContainer[source]: Return a string representing the date, controlled by an explicit format string.

IndexYearGO.via_dt.strptime(format)

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.strptime(format: str) → TContainer[source]: Return a Python datetime object from parsing a string defined with format.

IndexYearGO.via_dt.strpdate(format)

IndexYearGO.via_dt: Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.strpdate(format: str) → TContainer[source]: Return a Python date object from parsing a string defined with format.

IndexYearGO: Accessor String¶

Overview: IndexYearGO: Accessor String

IndexYearGO.via_str.capitalize

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.capitalize() → TContainer[source]: Return a container with only the first character of each element capitalized.

IndexYearGO.via_str.center(width, fillchar)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.center(width: int, fillchar: str = ' ') → TContainer[source]: Return a container with its elements centered in a string of length width.

IndexYearGO.via_str.count(sub, start, end)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.count(sub: str, start: Optional[int] = None, end: Optional[int] = None) → TContainer[source]: Returns a container with the number of non-overlapping occurrences of substring sub in the optional range start, end.

IndexYearGO.via_str.decode(encoding, errors)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.decode(encoding: Optional[str] = None, errors: Optional[str] = None) → TContainer[source]: Apply str.decode() to each element. Elements must be bytes.

IndexYearGO.via_str.encode(encoding, errors)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.encode(encoding: Optional[str] = None, errors: Optional[str] = None) → TContainer[source]: Apply str.encode() to each element. Elements must be strings.

IndexYearGO.via_str.endswith(suffix, start, end)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.endswith(suffix: Union[str, Iterable[str]], start: Optional[int] = None, end: Optional[int] = None) → TContainer[source]: Returns a container with the number of non-overlapping occurrences of substring suffix (or an interable of suffixes) in the optional range start, end.

IndexYearGO.via_str.find(sub, start, end)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.find(sub: str, start: Optional[int] = None, end: Optional[int] = None) → TContainer[source]: For each element, return the lowest index in the string where substring sub is found.

IndexYearGO.via_str.index(sub, start, end)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.index(sub: str, start: Optional[int] = None, end: Optional[int] = None) → TContainer[source]: Like find, but raises ValueError when the substring is not found.

IndexYearGO.via_str.isalnum

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.isalnum() → TContainer[source]: Returns true for each element if all characters in the string are alphanumeric and there is at least one character, false otherwise.

IndexYearGO.via_str.isalpha

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.isalpha() → TContainer[source]: Returns true for each element if all characters in the string are alphabetic and there is at least one character, false otherwise.

IndexYearGO.via_str.isdecimal

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.isdecimal() → TContainer[source]: For each element, return True if there are only decimal characters in the element.

IndexYearGO.via_str.isdigit

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.isdigit() → TContainer[source]: Returns true for each element if all characters in the string are digits and there is at least one character, false otherwise.

IndexYearGO.via_str.islower

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.islower() → TContainer[source]: Returns true for each element if all cased characters in the string are lowercase and there is at least one cased character, false otherwise.

IndexYearGO.via_str.isnumeric

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.isnumeric() → TContainer[source]: For each element in self, return True if there are only numeric characters in the element.

IndexYearGO.via_str.isspace

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.isspace() → TContainer[source]: Returns true for each element if there are only whitespace characters in the string and there is at least one character, false otherwise.

IndexYearGO.via_str.istitle

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.istitle() → TContainer[source]: Returns true for each element if the element is a titlecased string and there is at least one character, false otherwise.

IndexYearGO.via_str.isupper

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.isupper() → TContainer[source]: Returns true for each element if all cased characters in the string are uppercase and there is at least one character, false otherwise.

IndexYearGO.via_str.ljust(width, fillchar)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.ljust(width: int, fillchar: str = ' ') → TContainer[source]: Return a container with its elements ljusted in a string of length width.

IndexYearGO.via_str.len

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.len() → TContainer[source]: Return the length of the string.

IndexYearGO.via_str.lower

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.lower() → TContainer[source]: Return an array with the elements of self converted to lowercase.

IndexYearGO.via_str.lstrip(chars)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.lstrip(chars: Optional[str] = None) → TContainer[source]: For each element, return a copy with the leading characters removed.

IndexYearGO.via_str.partition(sep)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.partition(sep: str) → TContainer[source]: Partition each element around sep.

IndexYearGO.via_str.replace(old, new, count)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.replace(old: str, new: str, count: Optional[int] = None) → TContainer[source]: Return a container with its elements replaced in a string of length width.

IndexYearGO.via_str.rfind(sub, start, end)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.rfind(sub: str, start: Optional[int] = None, end: Optional[int] = None) → TContainer[source]: For each element, return the highest index in the string where substring sub is found, such that sub is contained within start, end.

IndexYearGO.via_str.rindex(sub, start, end)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.rindex(sub: str, start: Optional[int] = None, end: Optional[int] = None) → TContainer[source]: Like rfind, but raises ValueError when the substring sub is not found.

IndexYearGO.via_str.rjust(width, fillchar)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.rjust(width: int, fillchar: str = ' ') → TContainer[source]: Return a container with its elements rjusted in a string of length width.

IndexYearGO.via_str.rpartition(sep)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.rpartition(sep: str) → TContainer[source]: Partition (split) each element around the right-most separator.

IndexYearGO.via_str.rsplit(sep, maxsplit)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.rsplit(sep: str, maxsplit: int = - 1) → TContainer[source]: For each element, return a tuple of the words in the string, using sep as the delimiter string.

IndexYearGO.via_str.rstrip(chars)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.rstrip(chars: Optional[str] = None) → TContainer[source]: For each element, return a copy with the trailing characters removed.

IndexYearGO.via_str.split(sep, maxsplit)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.split(sep: str, maxsplit: int = - 1) → TContainer[source]: For each element, return a tuple of the words in the string, using sep as the delimiter string.

IndexYearGO.via_str.startswith(prefix, start, end)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.startswith(prefix: Union[str, Iterable[str]], start: Optional[int] = None, end: Optional[int] = None) → TContainer[source]: Returns a container with the number of non-overlapping occurrences of substring prefix (or an interable of prefixes) in the optional range start, end.

IndexYearGO.via_str.strip(chars)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.strip(chars: Optional[str] = None) → TContainer[source]: For each element, return a copy with the leading and trailing characters removed.

IndexYearGO.via_str.swapcase

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.swapcase() → TContainer[source]: Return a container with uppercase characters converted to lowercase and vice versa.

IndexYearGO.via_str.title

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.title() → TContainer[source]: Return a container with uppercase characters converted to lowercase and vice versa.

IndexYearGO.via_str.upper

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.upper() → TContainer[source]: Return a container with uppercase characters converted to lowercase and vice versa.

IndexYearGO.via_str.zfill(width)

IndexYearGO.via_str: Interface for applying string methods to elements in this container.

InterfaceString.zfill(width: int) → TContainer[source]: Return the string left-filled with zeros.

IndexYearGO: Accessor Regular Expression¶

Overview: IndexYearGO: Accessor Regular Expression

IndexYearGO.via_re(pattern, flags).search(pos, endpos)

via_re = <function Index.via_re>

InterfaceRe.search(pos: int = 0, endpos: Optional[int] = None) → TContainer[source]

Scan through string looking for the first location where this regular expression produces a match and return True, else False. Note that this is different from finding a zero-length match at some point in the string.

Parameters

pos – Gives an index in the string where the search is to start; it defaults to 0.
endpos – Limits how far the string will be searched; it will be as if the string is endpos characters long.

IndexYearGO.via_re(pattern, flags).match(pos, endpos)

via_re = <function Index.via_re>

InterfaceRe.match(pos: int = 0, endpos: Optional[int] = None) → TContainer[source]

If zero or more characters at the beginning of string match this regular expression return True, else False. Note that this is different from a zero-length match.

Parameters

pos – Gives an index in the string where the search is to start; it defaults to 0.
endpos – Limits how far the string will be searched; it will be as if the string is endpos characters long.

IndexYearGO.via_re(pattern, flags).fullmatch(pos, endpos)

via_re = <function Index.via_re>

InterfaceRe.fullmatch(pos: int = 0, endpos: Optional[int] = None) → TContainer[source]

If the whole string matches this regular expression, return True, else False. Note that this is different from a zero-length match.

Parameters

pos – Gives an index in the string where the search is to start; it defaults to 0.
endpos – Limits how far the string will be searched; it will be as if the string is endpos characters long.

IndexYearGO.via_re(pattern, flags).split(maxsplit)

via_re = <function Index.via_re>

InterfaceRe.split(maxsplit: int = 0) → TContainer[source]

Split string by the occurrences of pattern. If capturing parentheses are used in pattern, then the text of all groups in the pattern are also returned as part of the resulting tuple.

Parameters: maxsplit – If nonzero, at most maxsplit splits occur, and the remainder of the string is returned as the final element of the tuple.

IndexYearGO.via_re(pattern, flags).findall(pos, endpos)

via_re = <function Index.via_re>

InterfaceRe.findall(pos: int = 0, endpos: Optional[int] = None) → TContainer[source]

Return all non-overlapping matches of pattern in string, as a tuple of strings. The string is scanned left-to-right, and matches are returned in the order found. If one or more groups are present in the pattern, return a tuple of groups; this will be a tuple of tuples if the pattern has more than one group. Empty matches are included in the result.

Parameters

pos – Gives an index in the string where the search is to start; it defaults to 0.
endpos – Limits how far the string will be searched; it will be as if the string is endpos characters long.

IndexYearGO.via_re(pattern, flags).sub(repl, count)

via_re = <function Index.via_re>

InterfaceRe.sub(repl: str, count: int = 0) → TContainer[source]

Return the string obtained by replacing the leftmost non-overlapping occurrences of pattern in string by the replacement repl. If the pattern is not found, the string is returned unchanged.

Parameters

repl – A string or a function; if it is a string, any backslash escapes in it are processed.
count – The optional argument count is the maximum number of pattern occurrences to be replaced; count must be a non-negative integer. If omitted or zero, all occurrences will be replaced.

IndexYearGO.via_re(pattern, flags).subn(repl, count)

via_re = <function Index.via_re>

InterfaceRe.subn(repl: str, count: int = 0) → TContainer[source]

Perform the same operation as sub(), but return a tuple (new_string, number_of_subs_made).

Parameters

repl – A string or a function; if it is a string, any backslash escapes in it are processed.
count – The optional argument count is the maximum number of pattern occurrences to be replaced; count must be a non-negative integer. If omitted or zero, all occurrences will be replaced.