List querying - libvcs._internal.query_list

QueryList is the backbone of the Manager/Cmd pattern. Every ls() method in libvcs returns a QueryList, enabling chainable filtering on the results.

How It’s Used

All Manager classes return QueryList from their ls() methods:

from libvcs.cmd.git import Git

git = Git(path='/path/to/repo')

# Each ls() returns a QueryList
branches = git.branches.ls()    # QueryList[GitBranchCmd]
tags = git.tags.ls()            # QueryList[GitTagCmd]
remotes = git.remotes.ls()      # QueryList[GitRemoteCmd]
stashes = git.stashes.ls()      # QueryList[GitStashEntryCmd]
worktrees = git.worktrees.ls()  # QueryList[GitWorktreeCmd]

Filtering

QueryList extends Python’s built-in list with Django-style lookups:

# Exact match
branches.filter(name='main')

# Case-insensitive contains
branches.filter(name__icontains='feature')

# Nested attribute access
branches.filter(commit__sha__startswith='abc123')

Available Lookups

Lookup

Description

exact

Exact match (default)

iexact

Case-insensitive exact match

contains

Substring match

icontains

Case-insensitive substring

startswith

Prefix match

istartswith

Case-insensitive prefix

endswith

Suffix match

iendswith

Case-insensitive suffix

in

Value in list

nin

Value not in list

regex

Regular expression match

iregex

Case-insensitive regex

Chaining

Filters can be chained and combined:

# Multiple conditions (AND)
branches.filter(name__startswith='feature', is_remote=False)

# Get single result
branches.get(name='main')

# Chain filters
branches.filter(is_remote=True).filter(name__contains='release')

API Reference

Utilities for filtering or searching list of objects / list data.

Note

This is an internal API not covered by versioning policy.

exception libvcs._internal.query_list.MultipleObjectsReturned[source]

Bases: Exception

The query returned multiple objects when only one was expected.

exception libvcs._internal.query_list.ObjectDoesNotExist[source]

Bases: Exception

The requested object does not exist.

libvcs._internal.query_list.keygetter(obj, path)[source]

Fetch values in objects and keys, supported nested data.

With dictionaries:

Return type:

None | Any | str | list[str] | Mapping[str, str]

Parameters:
>>> keygetter({ "food": { "breakfast": "cereal" } }, "food")
{'breakfast': 'cereal'}

>>> keygetter({ "food": { "breakfast": "cereal" } }, "food__breakfast")
'cereal'

With objects:

>>> from typing import Optional
>>> from dataclasses import dataclass, field

>>> @dataclass()
... class Food:
...     fruit: list[str] = field(default_factory=list)
...     breakfast: Optional[str] = None

>>> @dataclass()
... class Restaurant:
...     place: str
...     city: str
...     state: str
...     food: Food = field(default_factory=Food)

>>> restaurant = Restaurant(
...     place="Largo",
...     city="Tampa",
...     state="Florida",
...     food=Food(
...         fruit=["banana", "orange"], breakfast="cereal"
...     )
... )

>>> restaurant
Restaurant(place='Largo',
    city='Tampa',
    state='Florida',
    food=Food(fruit=['banana', 'orange'], breakfast='cereal'))

>>> keygetter(restaurant, "food")
Food(fruit=['banana', 'orange'], breakfast='cereal')

>>> keygetter(restaurant, "food__breakfast")
'cereal'
libvcs._internal.query_list.parse_lookup(obj, path, lookup)[source]

Check if field lookup key, e.g. “my__path__contains” has comparator, return val.

If comparator not used or value not found, return None.

Return type:

Any | None

Parameters:
>>> parse_lookup({ "food": "red apple" }, "food__istartswith", "__istartswith")
'red apple'

It can also look up objects:

>>> from dataclasses import dataclass

>>> @dataclass()
... class Inventory:
...     food: str

>>> item = Inventory(food="red apple")

>>> item
Inventory(food='red apple')

>>> parse_lookup(item, "food__istartswith", "__istartswith")
'red apple'
class libvcs._internal.query_list.LookupProtocol[source]

Bases: Protocol

Protocol for QueryList filtering operators.

__init__(*args, **kwargs)[source]
_abc_impl = <_abc._abc_data object>
_is_protocol = True
libvcs._internal.query_list.lookup_exact(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_iexact(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_contains(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_icontains(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_startswith(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_istartswith(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_endswith(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_iendswith(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_in(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_nin(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_regex(data, rhs)[source]
Return type:

bool

Parameters:
libvcs._internal.query_list.lookup_iregex(data, rhs)[source]
Return type:

bool

Parameters:
exception libvcs._internal.query_list.PKRequiredException[source]

Bases: Exception

__init__(*args)[source]
Parameters:

args (object)

Return type:

None

exception libvcs._internal.query_list.OpNotFound[source]

Bases: ValueError

__init__(op, *args)[source]
Parameters:
Return type:

None

class libvcs._internal.query_list.QueryList[source]

Bases: list[T], Generic[T]

Filter list of object/dictionaries. For small, local datasets.

Experimental, unstable.

With dictionaries:

>>> query = QueryList(
...     [
...         {
...             "place": "Largo",
...             "city": "Tampa",
...             "state": "Florida",
...             "foods": {"fruit": ["banana", "orange"], "breakfast": "cereal"},
...         },
...         {
...             "place": "Chicago suburbs",
...             "city": "Elmhurst",
...             "state": "Illinois",
...             "foods": {"fruit": ["apple", "cantelope"], "breakfast": "waffles"},
...         },
...     ]
... )

>>> query.filter(place="Chicago suburbs")[0]['city']
'Elmhurst'
>>> query.filter(place__icontains="chicago")[0]['city']
'Elmhurst'
>>> query.filter(foods__breakfast="waffles")[0]['city']
'Elmhurst'
>>> query.filter(foods__fruit__in="cantelope")[0]['city']
'Elmhurst'
>>> query.filter(foods__fruit__in="orange")[0]['city']
'Tampa'

>>> query.filter(foods__fruit__in="apple")
[{'place': 'Chicago suburbs',
    'city': 'Elmhurst',
    'state': 'Illinois',
    'foods':
        {'fruit': ['apple', 'cantelope'], 'breakfast': 'waffles'}}]

>>> query.filter(foods__fruit__in="non_existent")
[]

With objects:

>>> from typing import Any
>>> from dataclasses import dataclass, field

>>> @dataclass()
... class Restaurant:
...     place: str
...     city: str
...     state: str
...     foods: dict[str, Any]

>>> restaurant = Restaurant(
...     place="Largo",
...     city="Tampa",
...     state="Florida",
...     foods={
...         "fruit": ["banana", "orange"], "breakfast": "cereal"
...     }
... )

>>> restaurant
Restaurant(place='Largo',
    city='Tampa',
    state='Florida',
    foods={'fruit': ['banana', 'orange'], 'breakfast': 'cereal'})

>>> query = QueryList([restaurant])

>>> query.filter(foods__fruit__in="banana")
[Restaurant(place='Largo',
    city='Tampa',
    state='Florida',
    foods={'fruit': ['banana', 'orange'], 'breakfast': 'cereal'})]

>>> query.filter(foods__fruit__in="banana")[0].city
'Tampa'

>>> query.get(foods__fruit__in="banana").city
'Tampa'

With objects (nested):

>>> from typing import Optional
>>> from dataclasses import dataclass, field

>>> @dataclass()
... class Food:
...     fruit: list[str] = field(default_factory=list)
...     breakfast: Optional[str] = None

>>> @dataclass()
... class Restaurant:
...     place: str
...     city: str
...     state: str
...     food: Food = field(default_factory=Food)

>>> query = QueryList([
...     Restaurant(
...         place="Largo",
...         city="Tampa",
...         state="Florida",
...         food=Food(
...             fruit=["banana", "orange"], breakfast="cereal"
...         )
...     ),
...     Restaurant(
...         place="Chicago suburbs",
...         city="Elmhurst",
...         state="Illinois",
...         food=Food(
...             fruit=["apple", "cantelope"], breakfast="waffles"
...         )
...     )
... ])

>>> query.filter(food__fruit__in="banana")
[Restaurant(place='Largo',
    city='Tampa',
    state='Florida',
    food=Food(fruit=['banana', 'orange'], breakfast='cereal'))]

>>> query.filter(food__fruit__in="banana")[0].city
'Tampa'

>>> query.get(food__fruit__in="banana").city
'Tampa'

>>> query.filter(food__breakfast="waffles")
[Restaurant(place='Chicago suburbs',
    city='Elmhurst',
    state='Illinois',
    food=Food(fruit=['apple', 'cantelope'], breakfast='waffles'))]

>>> query.filter(food__breakfast="waffles")[0].city
'Elmhurst'

>>> query.filter(food__breakfast="non_existent")
[]
data: Sequence[TypeVar(T)]
pk_key: str | None
__init__(items=None)[source]
Parameters:

items (Iterable[T] | None)

Return type:

None

items()[source]
Return type:

list[tuple[str, TypeVar(T)]]

filter(matcher=None, **kwargs)[source]
Return type:

QueryList[TypeVar(T)]

Parameters:
get(matcher=None, default=<object object>, **kwargs)[source]
Return type:

TypeVar(T) | None

Parameters: