pandas.
Index
Immutable ndarray implementing an ordered, sliceable set. The basic object storing axis labels for all pandas objects.
If dtype is None, we find the dtype that best fits the data. If an actual dtype is provided, we coerce to that dtype if it’s safe. Otherwise, an error will be raised.
Make a copy of input ndarray.
Name to be stored in the index.
When True, attempt to create a MultiIndex if possible.
See also
RangeIndex
Index implementing a monotonic integer range.
CategoricalIndex
Index of Categorical s.
Categorical
MultiIndex
A multi-level, or hierarchical, Index.
IntervalIndex
An Index of Interval s.
Interval
DatetimeIndex
TimedeltaIndex
PeriodIndex
Int64Index
UInt64Index
Float64Index
Notes
An Index instance can only contain hashable objects
Examples
>>> pd.Index([1, 2, 3]) Int64Index([1, 2, 3], dtype='int64')
>>> pd.Index(list('abc')) Index(['a', 'b', 'c'], dtype='object')
Attributes
T
Return the transpose, which is by definition self.
array
The ExtensionArray of the data backing this Series or Index.
asi8
Integer representation of the values.
dtype
Return the dtype object of the underlying data.
hasnans
Return if I have any nans; enables various perf speedups.
inferred_type
Return a string of the type inferred from the values.
is_monotonic
Alias for is_monotonic_increasing.
is_monotonic_decreasing
Return if the index is monotonic decreasing (only equal or decreasing) values.
is_monotonic_increasing
Return if the index is monotonic increasing (only equal or increasing) values.
is_unique
Return if the index has unique values.
nbytes
Return the number of bytes in the underlying data.
ndim
Number of dimensions of the underlying data, by definition 1.
nlevels
Number of levels.
shape
Return a tuple of the shape of the underlying data.
size
Return the number of elements in the underlying data.
values
Return an array representing the data in the Index.
empty
has_duplicates
is_all_dates
name
names
Methods
all(self, *args, **kwargs)
all
Return whether all elements are True.
any(self, *args, **kwargs)
any
Return whether any element is True.
append(self, other)
append
Append a collection of Index options together.
argmax(self[, axis, skipna])
argmax
Return an ndarray of the maximum argument indexer.
argmin(self[, axis, skipna])
argmin
Return a ndarray of the minimum argument indexer.
argsort(self, *args, **kwargs)
argsort
Return the integer indices that would sort the index.
asof(self, label)
asof
Return the label from the index, or, if not present, the previous one.
asof_locs(self, where, mask)
asof_locs
Find the locations (indices) of the labels from the index for every entry in the where argument.
astype(self, dtype[, copy])
astype
Create an Index with values cast to dtypes.
copy(self[, name, deep, dtype])
copy
Make a copy of this object.
delete(self, loc)
delete
Make new Index with passed location(-s) deleted.
difference(self, other[, sort])
difference
Return a new Index with elements from the index that are not in other.
drop(self, labels[, errors])
drop
Make new Index with passed list of labels deleted.
drop_duplicates(self[, keep])
drop_duplicates
Return Index with duplicate values removed.
droplevel(self[, level])
droplevel
Return index with requested level(s) removed.
dropna(self[, how])
dropna
Return Index without NA/NaN values.
duplicated(self[, keep])
duplicated
Indicate duplicate index values.
equals(self, other)
equals
Determine if two Index objects contain the same elements.
factorize(self[, sort, na_sentinel])
factorize
Encode the object as an enumerated type or categorical variable.
fillna(self[, value, downcast])
fillna
Fill NA/NaN values with the specified value.
format(self[, name, formatter])
format
Render a string representation of the Index.
get_indexer(self, target[, method, limit, …])
get_indexer
Compute indexer and mask for new index given the current index.
get_indexer_for(self, target, **kwargs)
get_indexer_for
Guaranteed return of an indexer even when non-unique.
get_indexer_non_unique(self, target)
get_indexer_non_unique
get_level_values(self, level)
get_level_values
Return an Index of values for requested level.
get_loc(self, key[, method, tolerance])
get_loc
Get integer location, slice or boolean mask for requested label.
get_slice_bound(self, label, side, kind)
get_slice_bound
Calculate slice bound that corresponds to given label.
get_value(self, series, key)
get_value
Fast lookup of value from 1-dimensional ndarray.
groupby(self, values)
groupby
Group the index labels by a given array of values.
holds_integer(self)
holds_integer
Whether the type is an integer type.
identical(self, other)
identical
Similar to equals, but check that other comparable attributes are also equal.
insert(self, loc, item)
insert
Make new Index inserting new item at location.
intersection(self, other[, sort])
intersection
Form the intersection of two Index objects.
is_(self, other)
is_
More flexible, faster check like is but that works through views.
is
is_categorical(self)
is_categorical
Check if the Index holds categorical data.
is_type_compatible(self, kind)
is_type_compatible
Whether the index type is compatible with the provided type.
isin(self, values[, level])
isin
Return a boolean array where the index values are in values.
isna(self)
isna
Detect missing values.
isnull(self)
isnull
item(self)
item
Return the first element of the underlying data as a python scalar.
join(self, other[, how, level, …])
join
Compute join_index and indexers to conform data structures to the new index.
map(self, mapper[, na_action])
map
Map values using input correspondence (a dict, Series, or function).
max(self[, axis, skipna])
max
Return the maximum value of the Index.
memory_usage(self[, deep])
memory_usage
Memory usage of the values.
min(self[, axis, skipna])
min
Return the minimum value of the Index.
notna(self)
notna
Detect existing (non-missing) values.
notnull(self)
notnull
nunique(self[, dropna])
nunique
Return number of unique elements in the object.
putmask(self, mask, value)
putmask
Return a new Index of the values set with the mask.
ravel(self[, order])
ravel
Return an ndarray of the flattened values of the underlying data.
reindex(self, target[, method, level, …])
reindex
Create index with target’s values (move/add/delete values as necessary).
rename(self, name[, inplace])
rename
Alter Index or MultiIndex name.
repeat(self, repeats[, axis])
repeat
Repeat elements of a Index.
searchsorted(self, value[, side, sorter])
searchsorted
Find indices where elements should be inserted to maintain order.
set_names(self, names[, level, inplace])
set_names
Set Index or MultiIndex name.
set_value(self, arr, key, value)
set_value
(DEPRECATED) Fast lookup of value from 1-dimensional ndarray.
shift(self[, periods, freq])
shift
Shift index by desired number of time frequency increments.
slice_indexer(self[, start, end, step, kind])
slice_indexer
For an ordered or unique index, compute the slice indexer for input labels and step.
slice_locs(self[, start, end, step, kind])
slice_locs
Compute slice locations for input labels.
sort(self, *args, **kwargs)
sort
Use sort_values instead.
sort_values(self[, return_indexer, ascending])
sort_values
Return a sorted copy of the index.
sortlevel(self[, level, ascending, …])
sortlevel
For internal compatibility with with the Index API.
str
alias of pandas.core.strings.StringMethods
pandas.core.strings.StringMethods
symmetric_difference(self, other[, …])
symmetric_difference
Compute the symmetric difference of two Index objects.
take(self, indices[, axis, allow_fill, …])
take
Return a new Index of the values selected by the indices.
to_flat_index(self)
to_flat_index
Identity method.
to_frame(self[, index, name])
to_frame
Create a DataFrame with a column containing the Index.
to_list(self)
to_list
Return a list of the values.
to_native_types(self[, slicer])
to_native_types
Format specified values of self and return them.
to_numpy(self[, dtype, copy, na_value])
to_numpy
A NumPy ndarray representing the values in this Series or Index.
to_series(self[, index, name])
to_series
Create a Series with both index and values equal to the index keys.
tolist(self)
tolist
transpose(self, *args, **kwargs)
transpose
union(self, other[, sort])
union
Form the union of two Index objects.
unique(self[, level])
unique
Return unique values in the index.
value_counts(self[, normalize, sort, …])
value_counts
Return a Series containing counts of unique values.
where(self, cond[, other])
where
Return an Index of same shape as self and whose corresponding entries are from self where cond is True and otherwise are from other.
is_boolean
is_floating
is_integer
is_interval
is_mixed
is_numeric
is_object
view