How to use paperwork-backend - 10 common examples

def get(self, obj_id):
        """
        Get a document or a page using its ID
        Won't instantiate them if they are not yet available
        """
        if BasicPage.PAGE_ID_SEPARATOR in obj_id:
            (docid, page_nb) = obj_id.split(BasicPage.PAGE_ID_SEPARATOR)
            page_nb = int(page_nb)
            return self._docs_by_id[docid].pages[page_nb]
        return self._docs_by_id[obj_id]

def get(self, obj_id):
        """
        Get a document or a page using its ID
        Won't instantiate them if they are not yet available
        """
        if BasicPage.PAGE_ID_SEPARATOR in obj_id:
            (docid, page_nb) = obj_id.split(BasicPage.PAGE_ID_SEPARATOR)
            page_nb = int(page_nb)
            return self._docs_by_id[docid].pages[page_nb]
        return self._docs_by_id[obj_id]

def __label_cmp(self, other):
        """
        Comparaison function. Can be used to sort labels alphabetically.
        """
        if other is None:
            return -1

        label_name = strip_accents(self.name).lower()
        other_name = strip_accents(other.name).lower()
        if label_name < other_name:
            return -1
        elif label_name == other_name:
            return 0
        else:
            return 1

        if self.get_color_str() < other.get_color_str():
            return -1
        elif self.get_color_str() == other.get_color_str():
            return 0
        else:
            return 1

dochash = doc.get_docfilehash()
        dochash = (u"%X" % dochash)

        doc_txt = self.get_doc_content(doc)
        labels_txt = doc.get_index_labels()
        assert(isinstance(labels_txt, str))

        query = whoosh.query.Term("docid", docid)
        index_writer.delete_by_query(query)

        index_writer.update_document(
            docid=docid,
            doctype=doc.doctype,
            docfilehash=dochash,
            content=doc_txt,
            label=strip_accents(labels_txt),
            date=doc.date,
            last_read=last_mod
        )
        return True

def __label_cmp(self, other):
        """
        Comparaison function. Can be used to sort labels alphabetically.
        """
        if other is None:
            return -1

        label_name = strip_accents(self.name).lower()
        other_name = strip_accents(other.name).lower()
        if label_name < other_name:
            return -1
        elif label_name == other_name:
            return 0
        else:
            return 1

        if self.get_color_str() < other.get_color_str():
            return -1
        elif self.get_color_str() == other.get_color_str():
            return 0
        else:
            return 1

def _del_doc(self, docid):
        doc = self.index.get_raw_doc_from_index(docid)
        doc_txt = doc['content']
        doc_labels = doc['labels']
        if doc_txt == "":
            logger.warning("Label guessing (del): Doc {} has no text".format(
                doc
            ))
            return

        for (label, guesser) in self.guesser._bayes.items():
            label = strip_accents(label)
            value = "yes" if label in doc_labels else "no"
            guesser.untrain(value, doc_txt)

def _add_doc(self, doc):
        doc_txt = self.index.get_doc_content(doc)
        if doc_txt == "":
            logger.warning("Label guessing (add): Doc {} has no text".format(
                doc.docid
            ))
            return

        labels = {label.name for label in doc.labels}

        # just in case, make sure all the labels are loaded
        for label in labels:
            self.guesser.load(label)

        for (label, guesser) in self.guesser._bayes.items():
            label = strip_accents(label)
            value = "yes" if label in labels else "no"
            guesser.train(value, doc_txt)

def find_documents(self, sentence, limit=None, must_sort=True,
                       search_type='fuzzy'):
        """
        Returns all the documents matching the given keywords

        Arguments:
            sentence --- a sentenced query
        Returns:
            An array of document (doc objects)
        """
        sentence = sentence.strip()
        sentence = strip_accents(sentence)

        if sentence == u"":
            return self.get_all_docs()

        result_list_list = []
        total_results = 0

        for query_parser in self.search_param_list[search_type]:
            query = query_parser["query_parser"].parse(sentence)

            sortedby = None
            if must_sort and "sortedby" in query_parser:
                sortedby = query_parser['sortedby']
            if sortedby:
                results = self.__searcher.search(
                    query, limit=limit, sortedby=sortedby

}
        )

    @staticmethod
    def get_select_mime_types():
        return IMG_MIME_TYPES

    @staticmethod
    def get_mime_types():
        return IMG_MIME_TYPES

    def __str__(self):
        return _("Append the image to the current document")


FS = fs.GioFileSystem()
IMPORTERS = [
    PdfDirectoryImporter(FS),
    PdfImporter(FS),
    ImageDirectoryImporter(FS),
    ImageImporter(FS),
]


def get_possible_importers(file_uris, current_doc=None):
    """
    Return all the importer objects that can handle the specified files.

    Possible imports may vary depending on the currently active document
    """
    importers = []
    for importer in IMPORTERS:

def __init__(self):
        self.fs = fs.GioFileSystem()