# Unix SMB/CIFS implementation. # # Query class for the ORM to the Ldb database. # # Copyright (C) Catalyst.Net Ltd. 2023 # # Written by Rob van der Linde # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # import re from .exceptions import DoesNotExist, MultipleObjectsReturned RE_SPLIT_CAMELCASE = re.compile(r"[A-Z](?:[a-z]+|[A-Z]*(?=[A-Z]|$))") class Query: """Simple Query class used by the `Model.query` method.""" def __init__(self, model, ldb, result): self.model = model self.ldb = ldb self.result = result self.count = result.count self.name = " ".join(RE_SPLIT_CAMELCASE.findall(model.__name__)).lower() def __iter__(self): """Loop over Query class yields Model instances.""" for message in self.result: yield self.model.from_message(self.ldb, message) def first(self): """Returns the first item in the Query or None for no results.""" if self.result.count: return self.model.from_message(self.ldb, self.result[0]) def last(self): """Returns the last item in the Query or None for no results.""" if self.result.count: return self.model.from_message(self.ldb, self.result[-1]) def get(self): """Returns one item or None if no results were found. :returns: Model instance or None if not found. :raises MultipleObjectsReturned: if more than one results were returned """ if self.count > 1: raise MultipleObjectsReturned( f"More than one {self.name} objects returned (got {self.count}).") elif self.count: return self.model.from_message(self.ldb, self.result[0]) def one(self): """Must return EXACTLY one item or raise an exception. :returns: Model instance :raises DoesNotExist: if no results were returned :raises MultipleObjectsReturned: if more than one results were returned """ if self.count < 1: raise DoesNotExist( f"{self.name.capitalize()} matching query not found") elif self.count > 1: raise MultipleObjectsReturned( f"More than one {self.name} objects returned (got {self.count}).") else: return self.model.from_message(self.ldb, self.result[0])