a Oc-@sfddlZddlmZddlmZddZGdddZGdd d ZGd d d ZGd d d eZ dS)N)wraps)RESOURCES_BY_TAGcs2t}|j|j}tfdd}|S)z decorator that checks function arguments for `concrete` and `resource` and will properly set them to class references if a string (reftag) is passed as the value cs~d}|d}ddD]V}||}|dkrFt|trF|j|||<n |dkrft|trf|j|||<|d7}q|i|S)Nrconcreteresource) isinstancestrREFTAG_CONCRETEREFTAG_RESOURCE)argskwargsibackendnamevaluefnnamesH/var/www/html/gsl.tools/lib/python3.9/site-packages/peeringdb/backend.pywrappeds zreftag_to_cls..wrapped)inspectgetfullargspecr defaultsr)rspec_rrrr reftag_to_clss   rc@seZdZdZddZdS)Fieldzp We use this to provide field instances to backends that don't use classes to describe their fields cCs||_d|_dSN)rcolumn)selfrrrr__init__&szField.__init__N)__name__ __module__ __qualname____doc__r!rrrrr src@s eZdZdZddZddZdS) EmptyContextzG We use this to provide a dummy context wherever it's optional cCsdSrrr rrr __enter__1szEmptyContext.__enter__cGsdSrr)r r rrr__exit__4szEmptyContext.__exit__N)r"r#r$r%r(r)rrrrr&+sr&c@s8eZdZdZeZeddZddZddZ dd Z d S) Basez Backend base class. Do NOT extend this directly when implementing a new backend, instead extend Interface below. cCs&t|ds dd|jD|_|jS)N _CONCRETE_MAPcSsi|]\}}||qSrr).0resrrrr Gsz%Base.CONCRETE_MAP..)hasattr RESOURCE_MAPitemsr+r'rrr CONCRETE_MAPDs  zBase.CONCRETE_MAPcCs |j|S)zm returns the concrete class for the resource Returns: - concrete class )r0)r r-rrr get_concreteLszBase.get_concretecCs ||jvS)z check if concrete class exists in the resource -> concrete mapping Returns: - bool: True if class exists in the resource -> concrete mapping r2r clsrrr is_concreteVszBase.is_concretecCs |j|S)zs returns the resource class for the concrete class Returns: - resource class r4r5rrr get_resource`szBase.get_resourceN) r"r#r$r%rr propertyr2r3r7r8rrrrr*8s   r*c@s(eZdZdZiZiZed6ddZed7ddZeddZ ed d Z e d d Z d dZ ddZddZe ddZe ddZe ddZe ddZe d8ddZe ddZe dd Ze d!d"Zd#d$Zd%d&Zd'd(Ze d)d*Ze d+d,Zd-d.Ze d/d0Zd9d2d3Zd4d5Z dS): InterfacezN backend adapter interface extend this when making a new backend NcCstS)a| should return the exception class that will be raised when an object fails validation Arguments: - concrete: if your backend has class specific validation errors and this is set, return the exception class that would be raised for this concrete class. Returns: - Exception class  Exceptionr6rrrrvalidation_error{szInterface.validation_errorcCstS)a should return the exception class that will be raised when an object cannot be found Arguments: - concrete: if your backend has class specific object missing errors and this is set, return the exception class that would be raised for this concrete class. Returns: - Exception class r;r=rrrobject_missing_errorszInterface.object_missing_errorcCstS)z Allows you to return an atomic transaction context if your backend supports it, if it does not, leave as is This should never return None Returns: - python context instance )r&r6rrratomic_transactions zInterface.atomic_transactioncCsdS)zn operations that need to be done ONCE during runtime to prepare usage for the backend Nrr@rrrsetupszInterface.setupcKs tdS)z should create object from dict and return it Arguments: - concrete: concrete class Keyword Arguments: - object field names -> values NNotImplementedError)r rdatarrr create_objects zInterface.create_objectcCs tdS)zD Delete all objects, essentially empty the database NrCr'rrr delete_allszInterface.delete_allcCs tdS)a2 Should parse error messages and collect the missing relationship errors as a dict of Resource -> {id set} and return it Arguments: - obj: concrete object instance - exc: exception instance Returns: - dict: {Resource : [ids]} NrC)r objexcrrrdetect_missing_relationssz"Interface.detect_missing_relationscCs tdS)aJ Should parse error message and collect any that describe violations of a uniqueness constraint. return the curresponding fields, else None Arguments: - exc: exception instance Returns: - list: list of fields - None: if no uniqueness errors NrC)r rIrrrdetect_uniqueness_errorsz!Interface.detect_uniqueness_errorcCs tdS)z Should return a list of field names for the concrete class Arguments: - concrete: concrete class Returns: - list: [,...] NrCr rrrrget_field_namess zInterface.get_field_namescCs tdS)z Return concrete class for relationship by field name Arguments: - concrete: concrete class - field_name Returns: - concrete class NrCr r field_namerrrget_field_concreteszInterface.get_field_concretecCs tdS)z should return instance of object with matching id Arguments: - concrete: concrete class - id: object primary key value Returns: - concrete instance NrC)r ridrrr get_objectszInterface.get_objectcCs tdS)a\ very simply search function that should return collection of objects where field matches value Arguments: - concrete: concrete class - field_name: query this field for a match - value: match this value (simple equal matching) Returns: - concrete instance NrCr rrOrrrr get_object_by#szInterface.get_object_bycCs tdS)aT should return collection of objects Arguments: - concrete: concrete class - ids: if specified should be a list of primary key values and only objects matching those values should be returned Returns: - collection of concrete instances NrC)r ridsrrr get_objects5szInterface.get_objectscCs tdS)ak very simple search function that should return collection of objects where field matches value Arguments: - concrete: concrete class - field_name: query this field for a match - value: match this value (simple equal matching) Returns: - collection of concrete instances NrC)r rfieldrrrrget_objects_byGszInterface.get_objects_bycCs tdS)aq Should return a tuple containing bools on whether a field signifies a relationship and if it's a single relationship or a relationship to multiple objects Arguments: - concrete: concrete class - field_name: query this field for a match Returns: - tuple: (bool related, bool many) NrCrNrrris_field_relatedYszInterface.is_field_relatedcCs tdS)z should return unix epoch timestamp of the `updated` field of the most recently updated object Arguments: - concrete: concrete class Returns: - int NrCrLrrr last_changekszInterface.last_changecCs tdS)zk Save the object instance Arguments: - obj: concrete object instance NrCr rHrrrsave{szInterface.savecCs tdS)a  Setup a many to many relationship Arguments: - obj: concrete object instance - field_name: name of the field that holds the relationship - objs: collection of concrete objects to setup relationships with NrC)r rHrOobjsrrrset_relation_many_to_manys z#Interface.set_relation_many_to_manycCst|||dS)a# update field on a concrete instance to value this does not have to commit to the database, which will be handled separately via the `save` method. Arguments: - obj: concrete object instance - field_name - value N)setattr)r rHrOrrrrupdates zInterface.updatecCst|S)a Should retrun a field instance, if your backend does not use classes to describe fields, leave this as is Arguments: - concrete: concrete class - field_name Returns: - field instance rrNrrr get_fieldszInterface.get_fieldcCsdd||DS)a Should return a collection of fields, if your backend does not use classes to describe fields, leave this as is Arguments: - concrete: concrete class Returns: - collection of field instances cSsg|] }t|qSrra)r,rrrr z(Interface.get_fields..) field_namesrLrrr get_fieldsszInterface.get_fieldscCsdS)z Should take an object instance and validate / clean it Arguments: - obj: concrete object instance Nrr[rrrcleanszInterface.cleancCsdS)z Should take a value and a field definition and do a value conversion if needed. should return the new value. Arguments: - concrete: concrete class - field_name - value NrrSrrr convert_fieldszInterface.convert_fieldrcCsdS)z Do database migrations Arguments: - verbosity : arbitrary verbosity setting, 0 = be silent, 1 = show some info about migrations. Nr)r verbosityrrrmigrate_databaseszInterface.migrate_databasecKsdS)zl Should return whether the database is fully migrated Returns: - bool Tr)r r rrris_database_migratedszInterface.is_database_migrated)N)N)N)r)!r"r#r$r%r0r classmethodr>r?rArBrrFrGrJrKrMrPrRrTrVrXrYrZr\r^r`rbrfrgrhrjrkrrrrr:ksX                    r:) r functoolsrZpeeringdb.resourcerrrr&r*r:rrrrs    3