mediagoblin/db/sql/fake.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 """
  19 This module contains some fake classes and functions to
  20 calm the rest of the code base. Or provide super minimal
  21 implementations.
  22
  23 Currently:
  24 - ObjectId "class": It's a function mostly doing
  25   int(init_arg) to convert string primary keys into
  26   integer primary keys.
  27 - InvalidId exception
  28 - DESCENDING "constant"
  29 """
  30
  31
  32 DESCENDING = object()  # a unique object for this "constant"
  33
  34
  35 class InvalidId(Exception):
  36     pass
  37
  38
  39 def ObjectId(value=None):
  40     if value is None:
  41         return None
  42     try:
  43         return int(value)
  44     except ValueError:
  45         raise InvalidId("%r is an invalid id" % value)