for-django-projects 1.1.2

Package of libraries for Django projects

For django projects

Classes and functions to create django projects with Bootstrap Css Framework

Installation

Requires Django v2.2+ and Python v3.6+ to run.

Add apps in INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'for_django_projects.form_utils',
    'for_django_projects.pwa'
    ...
]

Add in settings.py:

SIMBOLO_MONEDA = '$'
URL_GENERAL = 'http://your_domain.com'
CONSTRAINT_MSG = {} #dict of name of constraints as key and error message as value  

Classes

CustomValueDb

Inherited from django.db.models.Value, automatically adds data type in output_field attribute.

NormalModel

Inherited from django.db.models.Model, adds fields (in all models inheriting from NormalModel) according to the field type. Example: If there is a field of type BooleanField with the name is_enabled, then the is_enabled_boolhtml attribute will be added with a Fontawesome icon named fa-check-circle, otherwise fa-times-circle is added.

Attributes to be added in objects inherited from NormalModel according to field type:

django.db.models.BooleanField:

• fieldname_boolhtml ➝ SafeString: Return <i class="fas fas fa-clock text-info"></i> if fieldname value is None, <i class="fas fa-check-circle text-success"></i> if is True or <i class="fas fa-times-circle text-secondary"></i> if is False.
  
  
• fieldname_texthtml ➝ str: Return HABILITADO if fieldname value is True, else return DESHABILITADO.
  
  
• fieldname_yesorno ➝ str: Return Sí if fieldname value is True, else return No.

django.db.models.DecimalField:

• fieldname_unlocalize ➝ str: Returns the same value but replacing the comma , character with dot ..
  
  
• fieldname_money ➝ str: Return fieldname_unlocalize with settings.SIMBOLO_MONEDA, example $10.50.
  
  
• fieldname_integer ➝ int: Return the fieldname value rounded.

django.db.models.FileField:

• fieldname_icon ➝ SafeString: Returns Fontawesome icon according to file extension.
  
  
• fieldname_a_tag ➝ SafeString: Returns <a target="_blank" href="URL">{fieldname_icon} descargar</a>.
  
  
• fieldname_is_image ➝ bool.
  
  
• fieldname_extension ➝ str.

ModeloBase

Inherited from NormalModel, add new fields in model as fecha_registro -> models.DateTimeField and sin_eliminar -> models.BooleanField.

FormException

Custom exception that is used to handle errors in forms in a Django application.

The class constructor accepts three parameters: form, prefix, and suffix. form can be a Django form object or a list/tuple of Django form objects. prefix and suffix are used to add a prefix and suffix respectively to the form field names in case a specific field needs to be identified that has generated an error.

In the constructor, the superclass Exception constructor is called to initialize the error message. Then, a check is performed to determine whether form is a list/tuple or a single Django form object.

If form is a list/tuple, each form object is looped over and information about the errors for each field is collected and added to a list called self.errors.

If form is a single Django form object, information about the field errors is collected and added to the self.errors list. In both cases, the provided prefix and suffix are used to identify the specific field that has generated the error.

Then, a dictionary self.dict_error is created that contains information about the form error. This dictionary has the following keys:

• error: a boolean value indicating whether there has been an error in the form.
• form: a list of dictionaries containing information about the form field errors. Each dictionary has two keys: the field name and an error message.
• message: a general error message that is displayed in case a specific field that has generated an error cannot be identified.
• alerta: an HTML text string containing custom alert messages. These messages are displayed in case specific errors that are defined in a dictionary called settings.CONSTRAINT_MSG in the Django application configurations are detected.

License

MIT

Free Software, Hell Yeah!