pincer.utils.extraction.get_index() - Code Metrics - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

pincer.utils.extraction.get_index() A
last analyzed 2022-12-26 13:13 UTC

↳ Parent: pincer.utils.extraction

Complexity

Conditions

Size

Total Lines	28
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	28
rs	10
c	0
b	0
f	0
cc	2
nop	3

# Copyright Pincer 2021-Present

# Full MIT License can be found in `LICENSE` at the project root.

from typing import Any, Optional, Protocol, TypeVar

T = TypeVar("T")


class GetItem(Protocol):
    """Represents a class which implements the __getitem__ property."""

    def __getitem__(self, key: int) -> Any:
        return ...


def get_index(
    collection: GetItem, index: int, fallback: Optional[T] = None

) -> Optional[T]:
    """Gets an item from a collection through index.
    Allows you to provide a fallback for if that index is out of bounds.

    Parameters
    ----------
    collection: :class:`~pincer.utils.extraction.GetItem`
        The collection from which the item is retrieved.
    index: :class:`int`
        The index of the item in the collection.
    fallback: Optional[T]
        The fallback value which will be used if the index doesn't
        exist. Default value is None.

    Returns
    -------
    Optional[T]
        The item at the provided index from the collection, or if that
        item doesn't exist it will return the fallback value.
    """

    try:
        return collection[index]

    except IndexError:
        return fallback


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-09-01 19:26 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			from typing import Any, Optional, Protocol, TypeVar
5
6			T = TypeVar("T")
7
8
9			class GetItem(Protocol):
10			"""Represents a class which implements the __getitem__ property."""
11
12			def __getitem__(self, key: int) -> Any:
13			return ...
14
15
16			def get_index(
17			collection: GetItem, index: int, fallback: Optional[T] = None
			0 ignored issues – show Coding Style introduced 2021-11-14 22:09 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
18			) -> Optional[T]:
19			"""Gets an item from a collection through index.
20			Allows you to provide a fallback for if that index is out of bounds.
21
22			Parameters
23			----------
24			collection: :class:`~pincer.utils.extraction.GetItem`
25			The collection from which the item is retrieved.
26			index: :class:`int`
27			The index of the item in the collection.
28			fallback: Optional[T]
29			The fallback value which will be used if the index doesn't
30			exist. Default value is None.
31
32			Returns
33			-------
34			Optional[T]
35			The item at the provided index from the collection, or if that
36			item doesn't exist it will return the fallback value.
37			"""
38
39			try:
40			return collection[index]
41
42			except IndexError:
43			return fallback
44

Pincer-org / Pincer

pincer.utils.extraction.get_index() A last analyzed 2022-12-26 13:13 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

pincer.utils.extraction.get_index() A
last analyzed 2022-12-26 13:13 UTC