j5j9dZddlmZddlZddlZddlZddlZddlmZm Z ddl m Z ddl m Z ddlmZddlmZmZdd lmZdd lmZdd lmZdd lmZdd lmZmZddlmZddl m!Z!m"Z"ddl#m$Z$ddl%m&Z&m'Z'ddl(m)Z)ee*ze+zZ,ee,zZ-ej\Z/ d' d(dZ0Gdde Z1dddd d)dZ2 d* d+dZ3d,dZ4 d-dZ5eddd d.dZ6edddddddddddddddddddddddddddddddddddddddddddddddddddddddd7 d/d Z6 d*dddddddddddddddddddddddddddddddddddddddddddddddddddddddd7 d0d!Z6ddddddddddddddddddddddddddddddddddddddddd"( d1d#Z7dddddddddddddd$ d2d%Z8gd&Z9y)3a"Python API for OCRmyPDF. This module provides the main Python API for OCRmyPDF, allowing you to perform OCR operations programmatically without using the command line interface. Main Functions: ocr(): The primary function for OCR processing. Takes an input PDF or image file and produces an OCR'd PDF with searchable text. configure_logging(): Set up logging to match the command line interface behavior, with support for progress bars and colored output. Experimental Functions: _pdf_to_hocr(): Extract text from PDF pages and save as hOCR files for manual editing before final PDF generation. _hocr_to_ocr_pdf(): Convert hOCR files back to a searchable PDF after manual text corrections. The API maintains thread safety through internal locking since OCRmyPDF uses global state for plugins. Only one OCR operation can run per Python process at a time. For parallel processing, use multiple Python processes. Example: import ocrmypdf # Configure logging (optional) ocrmypdf.configure_logging(ocrmypdf.Verbosity.default) # Perform OCR ocrmypdf.ocr('input.pdf', 'output.pdf', language='eng') For detailed parameter documentation, see the ocr() function docstring and the equivalent command line parameters in the OCRmyPDF documentation. ) annotationsN)IterableSequence)IntEnum)IOBase)Path)BinaryIOoverload)warn)PageNumberFilter) OcrOptions)run_hocr_to_ocr_pdf_pipeline) run_pipelinerun_pipeline_cli)run_hocr_pipeline)OcrmypdfPluginManagerget_plugin_manager) check_options)ArgumentParser get_parser)ExitCodec|r |r td|sg}n&t|ttzr|g}n t |}|s t |}|j |jddlm }|}|j}i}|D]4}|s|jD]\}}|j|||||<6tj|||_|S)aSet up plugin infrastructure with proper initialization. This function handles: 1. Creating or validating the plugin manager 2. Calling plugin initialization hooks 3. Setting up plugin option registry Args: plugins: List of plugin paths/names to load plugin_manager: Existing plugin manager (if any) Returns: Properly initialized plugin manager Raises: ValueError: If both plugins and plugin_manager are provided 2plugins= and plugin_manager are mutually exclusive)plugin_managerr)PluginOptionRegistry) ValueError isinstancestrrlistr initializepluggyocrmypdf._plugin_registryrregister_optionsitemsregister_option_modelr register_plugin_models_option_registry) pluginsrrregistry option_modelsall_plugin_modelsplugin_options namespace model_classs B/var/www/html/qr/venv/lib/python3.12/site-packages/ocrmypdf/api.pysetup_plugin_infrastructurer0Hs*>MNN  GS4Z ()w- +G4^-B-BC?#%H#335M)+'; *8*>*>*@ ;& ;..y+F/:!), ;;%%&78'/N# c eZdZdZdZdZdZdZy) Verbosityz&Verbosity level for configure_logging.rN)__name__ __module__ __qualname____doc__quietdefaultdebug debug_allr1r/r3r3s0 EG EIr1r3TF)progress_bar_friendlymanage_root_loggerrc|rdnd}tj|}|jtjd}|r|r|j }|s$tj t j}|dkr |jtjnD|dk\r |jtjn|jtj|jt|dk\rd}nd }d}|stj| }|j||j||dkrtjd } | jtjtjd } | jtjtjd } | jtj|rtjd|S)a Set up logging. Before calling :func:`ocrmypdf.ocr()`, you can use this function to configure logging if you want ocrmypdf's output to look like the ocrmypdf command line interface. It will register log handlers, log filters, and formatters, configure color logging to standard error, and adjust the log levels of third party libraries. Details of this are fine-tuned and subject to change. The ``verbosity`` argument is equivalent to the argument ``--verbose`` and applies those settings. If you have a wrapper script for ocrmypdf and you want it to be very similar to ocrmypdf, use this function; if you are using ocrmypdf as part of an application that manages its own logging, you probably do not want this function. If this function is not called, ocrmypdf will not configure logging, and it is up to the caller of ``ocrmypdf.ocr()`` to set up logging as it wishes using the Python standard library's logging module. If this function is called, the caller may of course make further adjustments to logging. Regardless of whether this function is called, ocrmypdf will perform all of its logging under the ``"ocrmypdf"`` logging namespace. In addition, ocrmypdf imports pdfminer, which logs under ``"pdfminer"``. A library user may wish to configure both; note that pdfminer is extremely chatty at the log level ``logging.INFO``. This function does not set up the ``debug.log`` log file that the command line interface does at certain verbosity levels. Applications should configure their own debug logging. Args: verbosity: Verbosity level. progress_bar_friendly: If True (the default), install a custom log handler that is compatible with progress bars and colored output. manage_root_logger: Configure the process's root logger. plugin_manager: The plugin manager, used for obtaining the custom log handler. Returns: The toplevel logger for ocrmypdf (or the root logger, if we are managing it). ocrmypdfN)streamrr5r6z/%(levelname)7s %(name)s -%(pageno)s %(message)sz%(pageno)s%(message)s)fmtpdfminerPIL fontToolsT)logging getLoggersetLevelDEBUGget_logging_console StreamHandlersysstderrERRORINFO addFilterr Formatter setFormatter addHandlercaptureWarnings) verbosityr@rArprefixlogconsolerF formatter pdfminer_logpil_log fonttools_logs r/configure_loggingraszZ&R:F   F #CLLG/ 446 ''szz:1}' a'& &()A~?%I %%#.  #NN7A~((4 gmm,##E*&))+6 w}}-% Jr1c| t}hd|z}|jDcgc] \}}|||vr|}}}|j|j|r't ddj t |dycc}}w)aCheck that no individual OCR parameters conflict with OcrOptions. When a user passes an OcrOptions object, they should not also pass individual OCR parameters (except plugins/plugin_manager which are handled separately). Args: locals_dict: The locals() dict from the calling function. kwargs: The **kwargs dict from the calling function. excluded: Parameter names to exclude from conflict checking. Raises: ValueError: If conflicting parameters are found. N>kwargsoptionsr(rinput_file_or_optionsznWhen passing OcrOptions as the first argument, do not pass additional OCR parameters. Conflicting parameters: z, z). Set these values in OcrOptions instead.)setr$extendkeysrjoinsorted) locals_dictrcexcludedallowed_with_optionsnamevalue conflictss r/ _check_no_conflicting_ocr_paramsrqs&5  ',,. D%  -A!A IV[[]#Byy *+,-6 7  sBc>d|vrd|vr|jd}|yt|tr|jd}nQg}|D]H}t|tr%d|vr!|j |jd8|j |J|}||d<yd|vr|d=yy)aQMap the public API 'language' parameter to OcrOptions 'languages' field. The public API uses 'language' (matching CLI --language) but OcrOptions uses 'languages' (plural). This also coerces a bare string to a list and splits '+'-separated language codes (e.g. 'eng+deu' -> ['eng', 'deu']) to match the CLI behavior. language languagesN+)poprrsplitrgappend)options_kwargslangexpandeditems r/_remap_language_to_languagesr}s^# >(I!!*- <  dC ::c?D#%H *dC(SD[OODJJsO4OOD)  * D&*{# ~ % : & &r1c X|j}t|||d<||d<d|vrt|dttzr |j Dcic] \}}| || }}}i}t tjj}hd} ddh} t|jD]#} | |vs| | vs| | vr|j| || <% td i|} |r| jj|| Scc}}w#t$r} td| | d} ~ wwxYw) aConstruct an options object from the input/output files and keyword arguments. Args: input_file: Input file path or file object. output_file: Output file path or file object. parser: ArgumentParser object (kept for compatibility, may be used for plugin validation). **kwargs: Keyword arguments. Returns: OcrOptions: An options object containing the parsed arguments. Raises: TypeError: If the type of a keyword argument is not supported. input_file output_filesidecarN>redo_ocr force_ocr skip_text progress_barr(zFailed to create OcrOptions: r?)copyr}rr rr$rfr model_fieldsrhrrv extra_attrsupdate Exception TypeError)rrparserrcrykvr ocr_fieldslegacy_mode_flags known_extrakeyrdes r/create_optionsr:sZ&[[]N!0$.N< $/N=!N"zy!8f#4( (6';';'=Otq!adONOKZ,,1134J>"9-KN'')*3 * '8 8C;cic] \}=}>|=dvr|=|>}?}=}>|?j#|9t};t5t|5|6}6t};|6j|;d|9vr t%d |rt%d |?j'd d|rt%d |?j'd dt)d|<||;d|?}:t|:|6t|:|6cdddS#1swYyxYwcc}>}=w#1swYyxYw)aRun OCRmyPDF on one PDF or image. This function supports two calling conventions: **New style (recommended):** >>> from ocrmypdf import ocr >>> from ocrmypdf._options import OcrOptions >>> options = OcrOptions( ... input_file="input.pdf", ... output_file="output.pdf", ... languages=["eng"], ... ) >>> ocr(options) **Old style:** >>> ocr("input.pdf", "output.pdf", language=["eng"]) For most arguments, see documentation for the equivalent command line parameter. This API takes a threading lock, because OCRmyPDF uses global state in particular for the plugin system. The jobs parameter will be used to create a pool of worker threads or processes at different times, subject to change. A Python process can only run one OCRmyPDF task at a time. To run parallelize instances OCRmyPDF, use separate Python processes to scale horizontally. Generally speaking you should set jobs=sqrt(cpu_count) and run sqrt(cpu_count) processes as a starting point. If you have files with a high page count, run fewer processes and more jobs per process. If you have a lot of short files, run more processes and fewer jobs per process. A few specific arguments are discussed here: Args: input_file_or_options: Either an OcrOptions object containing all settings, or a path/stream for the input file (old-style API). output_file: Output file path or stream. Required when using old-style API with input_file as first argument. Must be None when passing OcrOptions. use_threads: Use worker threads instead of processes. This reduces performance but may make debugging easier since it is easier to set breakpoints. plugins: List of plugin paths to load. Can be passed alongside OcrOptions. plugin_manager: Pre-configured plugin manager. Can be passed alongside OcrOptions. For input_file (old-style API): If a :class:`pathlib.Path`, ``str`` or ``bytes``, this is interpreted as file system path to the input file. If the object appears to be a readable stream (with methods such as ``.read()`` and ``.seek()``), the object will be read in its entirety and saved to a temporary file. If ``input_file`` is ``"-"``, standard input will be read. For output_file (old-style API): If a :class:`pathlib.Path`, ``str`` or ``bytes``, this is interpreted as file system path to the output file. If the object appears to be a writable stream (with methods such as ``.write()`` and ``.seek()``), the output will be written to this stream. If ``output_file`` is ``"-"``, the output will be written to ``sys.stdout`` (provided that standard output does not seem to be a terminal device). When a stream is used as output, whether via a writable object or ``"-"``, some final validation steps are not performed (we do not read back the stream after it is written). Raises: ocrmypdf.MissingDependencyError: If a required dependency program is missing or was not found on PATH. ocrmypdf.UnsupportedImageFormatError: If the input file type was an image that could not be read, or some other file type that is not a PDF. ocrmypdf.DpiError: If the input file is an image, but the resolution of the image is not credible (allowing it to proceed would cause poor OCR). ocrmypdf.OutputFileAccessError: If an attempt to write to the intended output file failed. ocrmypdf.PriorOcrFoundError: If the input PDF seems to have OCR or digital text already, and settings did not tell us to proceed. ocrmypdf.InputFileError: Any other problem with the input file. ocrmypdf.SubprocessOutputError: Any error related to executing a subprocess. ocrmypdf.EncryptedPdfError: If the input PDF is encrypted (password protected). OCRmyPDF does not remove passwords. ocrmypdf.TesseractConfigError: If Tesseract reported its configuration was not valid. ValueError: If OcrOptions is passed along with other OCR parameters, or if both plugins and plugin_manager are provided. TypeError: If output_file is missing when using the old-style API. Returns: :class:`ocrmypdf.ExitCode` rNrrrdrzocr() missing required argument: 'output_file'. Either pass output_file as the second argument, or pass an OcrOptions object as the first argument.>rcrrrreverbosezDocrmypdf.ocr(verbose=) is ignored. Use ocrmypdf.configure_logging().pjbig2_lossy is deprecated and will be ignored. Lossy JBIG2 has been removed due to character substitution risks.r8jbig2_page_group_size is deprecated and will be ignored.r)rrrr?)rr rqlocalsrr(rrr _api_lockr0r add_optionsrrrr$rr rvr)@rerrsrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr(rrrrcrdrrrrcreate_options_kwargss@ r/rrs\f'4' )6: ~QR R ?oo+G gsTz *iG'.d7mBG P8N \F  & &f & 5 '> 2O P P+  >  ~QR RG t ,iG7mG ( ! 1 qD !  !  $$V, " P8N  \F  & &f & 5F"8 X&))->$OP%))*A4H$%'( G '> 2OE" P" Pa P PB ! " P" Ps 8AH(HBHHH )(rsrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr(rc( |(r |'r td|(sg}(n&t|(ttzr|(g}(n t |(}(|*j }+||+d<d|+d<t jD]\},}-|,dvs |-|-|+|,<t|+|(r|(|+d<|+jD./cic] \}.}/|/ |.|/ }+}.}/||+d<i}0ttjj}1hd }2d dh}3t |+jD]#}4|4|1vs|4|2vs|4|3vr|+j|4|0|4<%t5t|(|' }'|'j!t#  tdi|+}5|0r|5j$j'|0t-|5|'cdddScc}/}.w#t($r}6t+d |6|6d}6~6wwxYw#1swYyxYw)a Partially run OCRmyPDF and produces an output folder containing hOCR files. Given a PDF file, this function will run OCRmyPDF up to the point where the PDF is rasterized to images, OCRed, and the hOCR files are produced, all of which are saved to the output folder. This is useful for applications that want to provide an interface for users to edit the text before rendering the final PDF. Use :func:`hocr_to_ocr_pdf` to produce the final PDF. For arguments not explicitly documented here, see documentation for the equivalent command line parameter. This API is **experimental** and subject to change. Args: input_pdf: Input PDF file path. output_folder: Output folder path. **kwargs: Keyword arguments. rr /dev/nullr>rcr( input_pdf output_folderrNr(r>rrrrrrz/Failed to create OcrOptions for hOCR pipeline: rr?)rrrrrrrr$r}rfr rrhrvrr0rrrrrrr)7rrrsrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr(rrcry param_name param_valuerrrrrrrrdrs7 r/ _pdf_to_hocrrsD>MNN  GS4Z ()w-[[]N$-N< $/N=!$*8>>#35 K X Y')4N: & 5!0$+y!(6';';'=Otq!adONO'4N?#KZ,,1134J>!9-KN'')*3 * '8 8C;2G##**;7 !P'QQ#P> A!E  QQs<' F2F5(G(F" G" F?+F::F??GG ) rrrrrrrrrrrrr(c  |r | r td|sg}n&t|ttzr|g}n t |}|j }d|d<||d<t jD]\}}|dvs ||||<|r||d<|jDcic] \}}| || }}}|rtd|jd d|rtd |jd d||d <i}ttjj}hd }ddh}t |jD]#}||vs||vs||vr|j|||<%t5t|| } | j!t# tdi|}|r|j$j'|t-|| cdddScc}}w#t($r}t+d||d}~wwxYw#1swYyxYw)ayRun OCRmyPDF on a work folder and produce an output PDF. After running :func:`pdf_to_hocr`, this function will run OCRmyPDF on the work folder to produce an output PDF. This function consolidates any changes made to the hOCR files in the work folder and produces a final PDF. For arguments not explicitly documented here, see documentation for the equivalent command line parameter. This API is **experimental** and subject to change. Args: work_folder: Work folder path, as generated by :func:`pdf_to_hocr`. output_file: Output PDF file path. **kwargs: Keyword arguments. rrrr>rcr(r work_folderrNr(rrrrr>rrrrrrz6Failed to create OcrOptions for hOCR to PDF pipeline: rr?)rrrrrrrr$r rvrfr rrhrr0rrrrrrr)rrrrrrrrrrrrrrr(rcryrrrrrrrrrrdrs r/_hocr_to_ocr_pdfrMsKF>MNN  GS4Z ()w-[[]N$/N< $/N=!$*8>>#35 K X Y')4N: & 5$+y!(6';';'=Otq!adONO  P  =$/ GH2D9%0N=!KZ,,1134J>!9-KN'')*3 * '8 8C;2G##**;7 ,N '  9PT HL    s< G'G((G5(G9 G5 G2G--G22G55G>) r r3rrarrrrrrr0)NN)r(Sequence[Path | str] | NonerOcrmypdfPluginManager | Nonereturnr)rYr3r@boolrArrrr)rkdictrcrrlzset[str] | NonerNone)ryrrr)rPathOrIOrrrrrr )rdr r(Iterable[Path | str] | Nonerrrr)trerrrrsIterable[str] | Noner int | Noner str | NonerPathOrIO | Nonerrr bool | Nonerrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr float | Nonerrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrros.PathLike | Nonerrrrrrrrrrrrr(rrrrrrrrr)trezPathOrIO | OcrOptionsrrrsrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr(rrrrrrrrr)Rrrrrrsrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr(rrr)rrrrrrrrrrrrrrrrrrrrrrrrrrr(r):r: __future__rrJosrP threadingcollections.abcrrenumriorpathlibrtypingr r warningsr ocrmypdf._loggingr ocrmypdf._optionsr #ocrmypdf._pipelines.hocr_to_ocr_pdfrocrmypdf._pipelines.ocrrrocrmypdf._pipelines.pdf_to_hocrrocrmypdf._plugin_managerrrocrmypdf._validationr ocrmypdf.clirrocrmypdf.exceptionsrrbytesStrPathrLockrr0r3rarqr}rrrr__all__r?r1r/rs "H# .%.(LB=N.3( *u  g  INN  ,037: (:0::z#'$37 ZZ Z Z 1 Z@!%/ / / /  / d'8=D=D*2=D&?<@"A<B C<D$E<F+G<H&I<JK<L'M<NO<PQ<R$S<T ,U<V!+W<X(3Y<Z)[<\']<^ *_<`#a<b&c<d e<f$/g<h$/i<j k<lm<n)o<p1q<r&s<tu<xy< <B$({P&* "## $%)##!"&!! !""#(,$(&*-1(, $)-#!&*.2-159+/)-,0%)(,"&1515"& $+/37(, $u{P0{P {P# {P  {P  {P{P {P{P {P {P{P{P{P#{P !{P" #{P$%{P&'{P(){P* +{P, -{P./{P01{P23{P45{P67{P89{P:;{P<={P>&?{P@"A{PB C{PD$E{PF+G{PH&I{PJK{PL'M{PNO{PPQ{PR$S{PT ,U{PV!+W{PX(3Y{PZ)[{P\']{P^ *_{P`#a{Pb&c{Pd e{Pf$/g{Ph$/i{Pj k{Plm{Pn)o{Pp1q{Pr&s{Ptu{Pxy{PD&* # $%)##!"&!! !&*-1(, $)-&*.2-159+/!%)(,1515+/(,WHQHQHQ# HQ  HQ  HQHQ HQ HQHQHQHQ#HQ HQ HQ !HQ"#HQ$%HQ& 'HQ( )HQ*+HQ,-HQ./HQ01HQ2 3HQ4$5HQ6+7HQ8&9HQ:;HQ<'=HQ>$?HQ@ ,AHQB!+CHQD(3EHQF)GHQHIHQJ#KHQL&MHQN$/OHQP$/QHQT)UHQV&WHQ^#""#(,$()-,0"&+/!s s s   s  s  s s s s &s "s 's  *s  s )!s l r1