wdfHdZddlmZmZmZmZddlmZddl m Z m Z m Z dZ dZdZdZd Zd Zd Zd Zd ZdZdZdZdZdZdZdZdZdZdZdZ dZ!dZ"dZ#dZ$dZ%Gdde&Z' d#d!Z(ed d d d fd"Z)d S)$a7 Form generation utilities for App Engine's ``db.Model`` class. The goal of ``model_form()`` is to provide a clean, explicit and predictable way to create forms based on ``db.Model`` classes. No malabarism or black magic should be necessary to generate a form for models, and to add custom non-model related fields: ``model_form()`` simply generates a form class that can be used as it is, or that can be extended directly or even be used to create other forms using ``model_form()``. Example usage: .. code-block:: python from google.appengine.ext import db from tipfy.ext.model.form import model_form # Define an example model and add a record. class Contact(db.Model): name = db.StringProperty(required=True) city = db.StringProperty() age = db.IntegerProperty(required=True) is_admin = db.BooleanProperty(default=False) new_entity = Contact(key_name='test', name='Test Name', age=17) new_entity.put() # Generate a form based on the model. ContactForm = model_form(Contact) # Get a form populated with entity data. entity = Contact.get_by_key_name('test') form = ContactForm(obj=entity) Properties from the model can be excluded from the generated form, or it can include just a set of properties. For example: .. code-block:: python # Generate a form based on the model, excluding 'city' and 'is_admin'. ContactForm = model_form(Contact, exclude=('city', 'is_admin')) # or... # Generate a form based on the model, only including 'name' and 'age'. ContactForm = model_form(Contact, only=('name', 'age')) The form can be generated setting field arguments: .. code-block:: python ContactForm = model_form(Contact, only=('name', 'age'), field_args={ 'name': { 'label': 'Full name', 'description': 'Your name', }, 'age': { 'label': 'Age', 'validators': [validators.NumberRange(min=14, max=99)], } }) The class returned by ``model_form()`` can be used as a base class for forms mixing non-model fields and/or other model forms. For example: .. code-block:: python # Generate a form based on the model. BaseContactForm = model_form(Contact) # Generate a form based on other model. ExtraContactForm = model_form(MyOtherModel) class ContactForm(BaseContactForm): # Add an extra, non-model related field. subscribe_to_news = f.BooleanField() # Add the other model form as a subform. extra = f.FormField(ExtraContactForm) The class returned by ``model_form()`` can also extend an existing form class: .. code-block:: python class BaseContactForm(Form): # Add an extra, non-model related field. subscribe_to_news = f.BooleanField() # Generate a form based on the model. ContactForm = model_form(Contact, base_class=BaseContactForm) )Form validatorswidgetsfields) iteritems)GeoPtPropertyFieldReferencePropertyFieldStringListPropertyFieldc|dtjdtjdi|S)zd Returns a ``TextField``, applying the ``db.StringProperty`` length limit of 500 bytes. rmax)appendrlengthf TextField)kwargss ]/var/www/book.euthymeo.com/html/venv/lib/python3.11/site-packages/wtforms/ext/appengine/db.py get_TextFieldrcsA  < 1c : : :;;; ;   ctjdd}|d|tjdi|S)z\ Returns an ``IntegerField``, applying the ``db.IntegerProperty`` range limits. llminrrr)r NumberRangerr IntegerField)rvs rget_IntegerFieldrlsJ #6 # #F # ##rc|jr?|dtjdt jdi|St |S)z1Returns a form field for a ``db.StringProperty``.rr r Nr) multilinerrrr TextAreaFieldrmodelproprs rconvert_StringPropertyr%vsW ~%|##J$5#$>$>$>???(((((V$$$rc t|S)z5Returns a form field for a ``db.ByteStringProperty``.rr"s rconvert_ByteStringPropertyr(   rc$tjdi|S)z2Returns a form field for a ``db.BooleanProperty``.r)r BooleanFieldr"s rconvert_BooleanPropertyr,s > # #F # ##rc t|S)z2Returns a form field for a ``db.IntegerProperty``.)rr"s rconvert_IntegerPropertyr.s F # ##rc$tjdi|S)z0Returns a form field for a ``db.FloatProperty``.r)r FloatFieldr"s rconvert_FloatPropertyr1s < ! !& ! !!rcp|js|jrdS|ddtjdi|S)z3Returns a form field for a ``db.DateTimeProperty``.Nformatz%Y-%m-%d %H:%M:%Srauto_now auto_now_add setdefaultr DateTimeFieldr"s rconvert_DateTimePropertyr9sH })t h 3444 ? $ $V $ $$rcp|js|jrdS|ddtjdi|S)z/Returns a form field for a ``db.DateProperty``.Nr3z%Y-%m-%dr)r5r6r7r DateFieldr"s rconvert_DatePropertyr<sG })t h +++ ;   rcp|js|jrdS|ddtjdi|S)z/Returns a form field for a ``db.TimeProperty``.Nr3z%H:%M:%Srr4r"s rconvert_TimePropertyr>sG })t h +++ ? $ $V $ $$rcdS)z/Returns a form field for a ``db.ListProperty``.Nrr"s rconvert_ListPropertyr@ 4rctdi|S)z5Returns a form field for a ``db.StringListProperty``.r)r r"s rconvert_StringListPropertyrCs " , ,V , ,,rcf|j|d<|d|j tdi|S)z4Returns a form field for a ``db.ReferenceProperty``.reference_class allow_blankr)rEr7requiredr r"s rconvert_ReferencePropertyrHs? $ 4F  m%6777 ! + +F + ++rcdS)z8Returns a form field for a ``db.SelfReferenceProperty``.Nrr"s rconvert_SelfReferencePropertyrJrArcdS)z/Returns a form field for a ``db.UserProperty``.Nrr"s rconvert_UserPropertyrLrArc$tjdi|S)z/Returns a form field for a ``db.BlobProperty``.r)r FileFieldr"s rconvert_BlobPropertyrOs ;   rc$tjdi|S)z/Returns a form field for a ``db.TextProperty``.r)rr!r"s rconvert_TextPropertyrQs ? $ $V $ $$rc t|S)z3Returns a form field for a ``db.CategoryProperty``.r'r"s rconvert_CategoryPropertyrSr)rcx|dtjt|S)z/Returns a form field for a ``db.LinkProperty``.r)rrurlrr"s rconvert_LinkPropertyrVs1 <  0 0111   rcx|dtjt|S)z0Returns a form field for a ``db.EmailProperty``.r)rremailrr"s rconvert_EmailPropertyrYs2 < 0 2 2333   rctdi|S)z0Returns a form field for a ``db.GeoPtProperty``.r)rr"s rconvert_GeoPtPropertyr[s  ' ' ' ''rcdS)z-Returns a form field for a ``db.IMProperty``.Nrr"s rconvert_IMPropertyr]rArc t|S)z6Returns a form field for a ``db.PhoneNumberProperty``.r'r"s rconvert_PhoneNumberPropertyr_r)rc t|S)z8Returns a form field for a ``db.PostalAddressProperty``.r'r"s rconvert_PostalAddressPropertyrar)rc|dtjddtjdi|S)z1Returns a form field for a ``db.RatingProperty``.rrdrr)rrrrrr"s rconvert_RatingPropertyrdsA < 61# F F FGGG > # #F # ##rceZdZdZidededededede de d e d e d e d ed edededededeeeeeeedZegdZddZdZdS)ModelConvertera Converts properties from a ``db.Model`` class to form fields. Default conversions between properties and fields: +====================+===================+==============+==================+ | Property subclass | Field subclass | datatype | notes | +====================+===================+==============+==================+ | StringProperty | TextField | unicode | TextArea | | | | | if multiline | +--------------------+-------------------+--------------+------------------+ | ByteStringProperty | TextField | str | | +--------------------+-------------------+--------------+------------------+ | BooleanProperty | BooleanField | bool | | +--------------------+-------------------+--------------+------------------+ | IntegerProperty | IntegerField | int or long | | +--------------------+-------------------+--------------+------------------+ | FloatProperty | TextField | float | | +--------------------+-------------------+--------------+------------------+ | DateTimeProperty | DateTimeField | datetime | skipped if | | | | | auto_now[_add] | +--------------------+-------------------+--------------+------------------+ | DateProperty | DateField | date | skipped if | | | | | auto_now[_add] | +--------------------+-------------------+--------------+------------------+ | TimeProperty | DateTimeField | time | skipped if | | | | | auto_now[_add] | +--------------------+-------------------+--------------+------------------+ | ListProperty | None | list | always skipped | +--------------------+-------------------+--------------+------------------+ | StringListProperty | TextAreaField | list of str | | +--------------------+-------------------+--------------+------------------+ | ReferenceProperty | ReferencePropertyF| db.Model | | +--------------------+-------------------+--------------+------------------+ | SelfReferenceP. | ReferencePropertyF| db.Model | | +--------------------+-------------------+--------------+------------------+ | UserProperty | None | users.User | always skipped | +--------------------+-------------------+--------------+------------------+ | BlobProperty | FileField | str | | +--------------------+-------------------+--------------+------------------+ | TextProperty | TextAreaField | unicode | | +--------------------+-------------------+--------------+------------------+ | CategoryProperty | TextField | unicode | | +--------------------+-------------------+--------------+------------------+ | LinkProperty | TextField | unicode | | +--------------------+-------------------+--------------+------------------+ | EmailProperty | TextField | unicode | | +--------------------+-------------------+--------------+------------------+ | GeoPtProperty | TextField | db.GeoPt | | +--------------------+-------------------+--------------+------------------+ | IMProperty | None | db.IM | always skipped | +--------------------+-------------------+--------------+------------------+ | PhoneNumberProperty| TextField | unicode | | +--------------------+-------------------+--------------+------------------+ | PostalAddressP. | TextField | unicode | | +--------------------+-------------------+--------------+------------------+ | RatingProperty | IntegerField | int or long | | +--------------------+-------------------+--------------+------------------+ | _ReverseReferenceP.| None | | always skipped | +====================+===================+==============+==================+ StringPropertyByteStringPropertyBooleanPropertyIntegerProperty FloatPropertyDateTimeProperty DateProperty TimeProperty ListPropertyStringListPropertyReferencePropertySelfReferenceProperty UserProperty BlobProperty TextPropertyCategoryProperty LinkProperty) EmailProperty GeoPtProperty IMPropertyPhoneNumberPropertyPostalAddressPropertyRatingProperty)rorpriNc"|p|j|_dS)z Constructs the converter, setting the converter callables. :param converters: A dictionary of converter callables for each property type. The callable must accept the arguments (model, prop, kwargs). N)default_converters converters)selfrs r__init__zModelConverter.__init__Ys%?(?rct|j}|jdd|gd}|r|||jr5||jvr,|d tj|j r)d|vrd|j D|d<tj di|S|j|d}| ||||SdS) aD Returns a form field for a single model property. :param model: The ``db.Model`` class that contains the property. :param prop: The model property: a ``db.Property`` instance. :param field_args: Optional keyword arguments to construct the field. _ )labeldefaultrrchoicescg|]}||fSrr).0rs r z*ModelConverter.convert..}s$B$B$BaV$B$B$BrNr)type__name__namereplacetitle default_valueupdaterGNO_AUTO_REQUIREDrrrr SelectFieldrget)rr#r$ field_argsprop_type_namer converters rconvertzModelConverter.convertcs$d,Y&&sC006688))++    & MM* % % % = ?^43HHH < ' ' (;(=(= > > > < 6&&$B$BT\$B$B$By!=**6** *++NDAAI$ yf555%$rN) r __module__ __qualname____doc__r%r(r,r.r1r9r<r>r@rCrHrJrLrOrQrSrVrYr[r]r_rardr frozensetrrrrrrrfrfsc<<z!7!; !8 !8  !6  !9  !5 !5 !5 !; !: !> !5 !5 !5 !9!" !5#$"7!6!3!!7/6!y!Z!Z!Z[[@@@@66666rrfNc |p t}|pi}|}tt|d}t d|D |rt fd|D nrt fd D i} D]9}||||||} | | ||<:|S)a Extracts and returns a dictionary of form fields for a given ``db.Model`` class. :param model: The ``db.Model`` class to extract fields from. :param only: An optional iterable with the property names that should be included in the form. Only these properties will have fields. :param exclude: An optional iterable with the property names that should be excluded from the form. All other properties will have fields. :param field_args: An optional dictionary of field names mapping to a keyword arguments used to construct each field object. :param converter: A converter to generate the fields based on the model properties. If not set, ``ModelConverter`` is used. c|djS)N)creation_counter)r$s rzmodel_fields..s T!W=Ur)keyc3&K|] }|dV dS)rNr)rxs r zmodel_fields..s&22qt222222rc3$K|] }|v|V dSrr)rr field_namess rrzmodel_fields..s-??a;.>.>1.>.>.>.>??rc3$K|] }|v|V dSrr)rrexcludes rrzmodel_fields..s-FFQg5E5E15E5E5E5EFFr)rf propertiessortedrlistrr) r#onlyrrrprops sorted_props field_dictrfieldrs ` @r model_fieldsrs*-^--I!rJ     E)E**0U0UVVVL22\22222K G????d????? GFFFFkFFFFF J%%!!%tjnnT6J6JKK  $Jt  rcvt|||||}t|dz|f|S)a, Creates and returns a dynamic ``wtforms.Form`` class for a given ``db.Model`` class. The form class can be used as it is or serve as a base for extended form classes, which can then mix non-model related fields, subforms with other model forms, among other possibilities. :param model: The ``db.Model`` class to generate a form for. :param base_class: Base form class to extend from. Must be a ``wtforms.Form`` subclass. :param only: An optional iterable with the property names that should be included in the form. Only these properties will have fields. :param exclude: An optional iterable with the property names that should be excluded from the form. All other properties will have fields. :param field_args: An optional dictionary of field names mapping to keyword arguments used to construct each field object. :param converter: A converter to generate the fields based on the model properties. If not set, ``ModelConverter`` is used. r)rrkind)r# base_classrrrrrs r model_formrs<4eT7J JJJ  v% }j A AAr)NNNN)*rwtformsrrrrrwtforms.compatrwtforms.ext.appengine.fieldsrr r rrr%r(r,r.r1r9r<r>r@rCrHrJrLrOrQrSrVrYr[r]r_rardobjectrfrrrrrrsb\\z;:::::::::::$$$$$$llllllllll!!!$$$%%%!!! $$$ $$$ """ %%%!!!%%% --- ,,,  !!! %%% !!! !!! !!! (((  !!! !!! $$$ D6D6D6D6D6VD6D6D6N=A****Z"&D$4BBBBBBr