Models

class document_catalogue.models.Document(*args, **kwargs)

A file and the meta-data describing that file in the catalogue.

exception DoesNotExist

exception MultipleObjectsReturned

class PrivateFileField(*args, **kwargs)

Filefield with private storage, custom filename and size checks.

Extra settings: - upload_subfolder: a lambda to find the subfolder, depending on the instance. - content_types: list of allowed content types. - max_file_size: maximum file size.

clean(*args, **kwargs)

Convert the value’s type and run validation. Validation errors from to_python() and validate() are propagated. Return the correct value if no error is raised.

generate_filename(instance, filename)

Apply (if callable) or prepend (if a string) upload_to to the filename, then delegate further processing of the name to the storage backend. Until the storage layer, all file paths are expected to be Unix style (with forward slashes).

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

class document_catalogue.models.DocumentCategory(*args, **kwargs)

A hierarchical category system for assets

exception DoesNotExist

exception MultipleObjectsReturned

get_document_count()

Return the total number of documents uploaded for this category

has_children()

Return true if this DocumentCategory has dependent objects lower in the hierarchy

class document_catalogue.models.DocumentManager(*args, **kwargs)

Manager for Document model with all methods from DocumentQuerySet.

get_queryset()

Return a new QuerySet object. Subclasses can override this method to customize the behavior of the Manager.

class document_catalogue.models.DocumentQueryset(model=None, query=None, using=None, hints=None)

Custom query set for Document model

class document_catalogue.models.PublishedDocumentManager(*args, **kwargs)

Published documents only

get_queryset()

Return a new QuerySet object. Subclasses can override this method to customize the behavior of the Manager.

document_catalogue.models.document_upload_path_callback(instance, filename)

Dynamic upload path based on file instance