TAiCSrSSKJr SSKrSSKJrJr SSKJrJ r SSK J r SSK J r SSKJr \ "S \\5rSSS jjrSS jr"S S \R,5r"SS\R.5rSr\"\ SSSS9r\R7SSS/SS9 g)z4Command line interface customization and validation.) annotationsN)CallableMapping)AnyTypeVar)DEFAULT_ROTATE_PAGES_THRESHOLD) PROGRAM_NAME) __version__Tcv^^^TbT"T5OSmTbT"T5OSmSUUU4SjjnTRUlU$)zValidator for numeric command line parameters. Stipulates that the value must be of type basetype (typically int or float), and optionally, within the range [min_, max_]. Ncz>T"U5nTbUT:d Tb%UT:a[R"U<STT4<35eU$)Nz not in valid range )argparseArgumentTypeError)svaluebasetypemax_min_s H/var/www/html/land-ocr/venv/lib/python3.13/site-packages/ocrmypdf/cli.py_numericnumeric.._numericsR   43CPT ,,%+T4L+;<  )rstrreturnr )__name__)rrrrs``` rnumericrsD "-8D>4D!-8D>4D!))H Orc^SU4SjjnU$)z3Accept text on command line and convert to integer.c >TU$![a; [R"U<SSRTR 5535Sef=f)Nz must be one of: z, )KeyErrorrrjoinkeys)rmappings r _str_to_intstr_to_int.._str_to_int+sV 1:  ,,%(7<<>)B(CD  s AA )rrrint)r"r#s` r str_to_intr'(s rc>^\rSrSrSrU4SjrSrU4SjrSrU=r $)ArgumentParser6aOverride parser's default behavior of calling sys.exit(). https://stackoverflow.com/questions/5943249/python-argparse-and-controlling-overriding-the-exit-status-code OCRmyPDF began as a CLI but eventually acquired an API. The API works inside out, by synthesizing a command line argument. So we subclass the standard parser with one that doesn't call sys.exit(). Obviously this is not the ideal way to do things but it works for us. c4>[TU]"U0UD6 SUlg)zInitialize the parser.FN)super__init__ _api_mode)selfargskwargs __class__s rr-ArgumentParser.__init__As $)&)rcSUlg)zEnable API mode. When set, the parser will not call sys.exit() on error. OCRmyPDF was originally a command line program, but now it has an API. The API works by synthesizing command line arguments. TNr.)r/s renable_api_modeArgumentParser.enable_api_modeFs rc\>UR(d[TU] U5 g[U5e)z-Override the default argparse error behavior.N)r.r,error ValueError)r/messager2s rr9ArgumentParser.errorOs$~~ GM' " !!rr5) r __module__ __qualname____firstlineno____doc__r-r6r9__static_attributes__ __classcell__r2s@rr)r)6s ""rr)c:^\rSrSrSrSU4SjjrSSjrSrU=r$)LanguageSetActionWzManages a list of languages.c F>Uc [5n[TU]"X4SU0UD6 g)zInitialize the action.Ndefault)listr,r-)r/option_stringsdestrHr1r2s rr-LanguageSetAction.__init__Zs& ?fG IwI&Irc[X R5nSU;a0URS5Vs/sHoeRU5PM ngURU5 gs snf)zAdd a language to the set.+N)getattrrKsplitappend)r/parser namespacevalues option_stringrKlangs r__call__LanguageSetAction.__call__`sLy)), &=+1<<+< =+<4[[ +< = KK  >sAr&)N) rr=r>r?r@r-rWrArBrCs@rrErEWs&J   rrEc [[SS[RSSS9nUR SSSS 9 UR S S S S 9 UR S SS[ SS9 UR SS[ SS9 UR S/SQSSS9 UR SSSSSS S!9 UR S"S#[S$S%9 URS&5nUR S'S(S)[[ S*S+5S,S9 UR S-S.S/S0S19 UR S2S3[[ S*S45S*S5SS6S79 UR S8S9S:[RS;9 UR SS9S?[RS;9 URS@SA5nUR SB[SCSD9 UR SE[SFSD9 UR SG[SHSD9 UR SI[SJSD9 URSKSL5nUR SMSNS/SOS19 UR SPS/SQS19 UR SRSSS/STS19 UR SUSVS/SWS19 UR SXSYS/SZS19 UR S[[SS\S]9 UR S^S[[ S*S_5S*S`Sa9 UR SbS/ScS19 URSdSe5nUR SfSgS/ShS19 UR SiSjS/SkS19 UR SlS/SmS19 UR Sn[[S*S_5SoSpSq9 UR SrS/SsS19 URStSu5nUR Sv[SwSD9 UR SxSy[[S*5SoSzS{S|9 UR S}/S~QSSS9 UR S[[[S*S5SSS9 UR S[[S*5SSSS9 UR SS/SS19 UR SSS/SS9 URSS5nUR SSS/SS19 U$)zGet the main CLI parser.T@aGenerates a searchable PDF or PDF/A from a regular PDF. OCRmyPDF rasterizes each page of the input PDF, optionally corrects page rotation and performs image processing, runs the Tesseract OCR engine on the image, and then creates a PDF from the OCR information. a?OCRmyPDF attempts to keep the output file at about the same size. If a file contains losslessly compressed images, and images in the output file will be losslessly compressed as well. PDF is a page description file that attempts to preserve a layout exactly. A PDF can contain vector objects (such as text or lines) and raster objects (images). A page might have multiple images. OCRmyPDF is prepared to deal with the wide variety of PDFs that exist in the wild. When a PDF page contains text, OCRmyPDF assumes that the page has already been OCRed or is a "born digital" page that should not be OCRed. The default behavior is to exit in this case without producing a file. You can use the option --skip-text to ignore pages with text, or --force-ocr to rasterize all objects on the page and produce an image-only PDF as output. ocrmypdf --skip-text file_with_some_text_pages.pdf output.pdf ocrmypdf --force-ocr word_document.pdf output.pdf If you are concerned about long-term archiving of PDFs, use the default option --output-type pdfa which converts the PDF to a standardized PDF/A-2b. This removes some features from the PDF such as Javascript or forms. If you want to minimize the number of changes made to your PDF, use --output-type pdf. If OCRmyPDF is given an image file as input, it will attempt to convert the image to a PDF before processing. For more control over the conversion of images to PDF, use the Python package img2pdf or other image to PDF software. For example, this command uses img2pdf to convert all .png files beginning with the 'page' prefix to a PDF, fitting each image on A4-sized paper, and sending the result to OCRmyPDF through a pipe. img2pdf --pagesize A4 page*.png | ocrmypdf - myfile.pdf Online documentation is located at: https://ocrmypdf.readthedocs.io/en/latest/introduction.html )prog allow_abbrevfromfile_prefix_charsformatter_class descriptionepilog input_fileinput_pdf_or_imagezOPDF file containing the images to be OCRed (or '-' to read from standard input))metavarhelp output_file output_pdfzOutput searchable PDF file (or '-' to write to standard output). Existing files will be overwritten. If same as input file, the input file will be updated only if processing is successful.z-lz --language languageszLanguage(s) of the file to be OCRed (see tesseract --list-langs for all language packs installed in your system). Use -l eng+deu for multiple languages.)rKactionrdz --image-dpiDPIzWhen the input file is an image, not a PDF, use this DPI instead of the DPI claimed by the input file. If the input does not claim a sensible DPI, this option will be required.)rctyperdz --output-type)pdfapdfzpdfa-1zpdfa-2zpdfa-3nonerkaChoose output type. 'pdfa' creates a PDF/A-2b compliant file for long term archiving (default, recommended) but may not suitable for users who want their file altered as little as possible. 'pdfa' also has problems with full Unicode text. 'pdf' minimizes changes to the input file. 'pdf-a1' creates a PDF/A-1b file. 'pdf-a2' is equivalent to 'pdfa'. 'pdf-a3' creates a PDF/A-3b file. 'none' will produce no output, which may be helpful if only the --sidecar is desired.)choicesrHrdz --sidecar?NFILEaGenerate sidecar text files that contain the same text recognized by Tesseract. This may be useful for building a OCR text database. If FILE is omitted, the sidecar file be named {output_file}.txt; the next argument must NOT be the name of the input PDF. If FILE is set to '-', the sidecar is written to stdout (a convenient way to preview OCR quality). The output file and sidecar may not both use stdout at the same time.)nargsconstrHrcrdz --versionversionzPrint program version and exit)rhrtrdzJob control optionsz-jz--jobsNrz8Use up to N CPU cores simultaneously (default: use all).z-qz--quiet store_truezSuppress INFO messages)rhrdz-vz --verbosezPrint more verbose messages for each additional verbose level. Use `-v 1` typically for much more detailed logging. Higher numbers are probably only useful in debugging.)rjrHrsrrrdz--no-progress-bar store_false progress_bar)rhrKrdz --use-threads)rhrHrdz--no-use-threads use_threadszMetadata optionszCSet output PDF/A metadata (default: copy input document's metadata)z--titlez3Set document title (place multiple words in quotes))rjrdz--authorzSet document authorz --subjectz Set document subject descriptionz --keywordszSet document keywordszImage preprocessing optionsz7Options to improve the quality of the final PDF and OCRz-rz--rotate-pagesz=Automatically rotate pages based on detected text orientationz--remove-backgroundzKAttempt to remove background from gray or color pages, setting it to white z-dz--deskewz&Deskew each page before performing OCRz-cz--cleanzClean pages from scanning artifacts before performing OCR, and send the cleaned page to OCR, but do not include the cleaned page in the outputz-iz --clean-finalzgClean page as above, and incorporate the cleaned image in the final PDF. Might remove desired content.z--unpaper-argszmA quoted string of arguments to pass to unpaper. Requires --clean. Example: --unpaper-args '--layout double'.)rjrHrdz --oversampleizPOversample images to at least the specified DPI, to improve OCR results slightly)rcrjrHrdz--remove-vectorszEXPERIMENTAL. Mask out any vector objects in the PDF so that they will not be included in OCR. This can eliminate false characters.z OCR optionszControl how OCR is appliedz-fz --force-ocrzrRasterize any text or vector objects on each page, apply OCR, and save the rastered output (this rewrites the PDF)z-sz --skip-textzSkip OCR on any pages that already contain text, but include the page in final output; useful for PDFs that contain a mix of images, text pages, and/or previously OCRed pagesz --redo-ocraAttempt to detect and remove the hidden OCR layer from files that were previously OCRed with OCRmyPDF or another program. Apply OCR to text found in raster images. Existing visible text objects will not be changed. If there is no existing OCR, OCR will be added.z --skip-bigMPixelszkSkip OCR on pages larger than the specified amount of megapixels, but include skipped pages in final output)rjrcrdz--invalidate-digital-signatureszNormally, OCRmyPDF will refuse to OCR a PDF that has a digital signature. This option allows OCR to proceed, but the digital signature will be invalidated.Advancedz$Advanced options to control OCRmyPDFz--pageszMLimit OCR to the specified pages (ranges or comma separated), skipping othersz--max-image-mpixelsstorez[Set maximum number of megapixels to unpack before treating an image as a decompression bombg@o@)rhrjrcrdrHz--pdf-renderer)autohocrsandwich hocrdebugrzjChoose OCR PDF renderer - the default option is to let OCRmyPDF choose. See documentation for discussion.z--rotate-pages-thresholdi CONFIDENCEz]Only rotate pages when confidence is above this value (arbitrary units reported by tesseract))rHrjrcrdz--fast-web-viewg? MEGABYTESa~If the size of file is more than this threshold (in MB), then linearize the PDF for fast web viewing. This allows the PDF to be displayed before it is fully downloaded in web browsers, but increases the space required slightly. By default we skip this for small files which do not benefit. If the threshold is 0 it will be apply to all files. Set the threshold very high to disable.)rjrHrcrdz--continue-on-soft-render-erroraContinue processing pages after a recoverable PDF rendering error. A recoverable error is one that does not prevent the page from being rendered, but may result in visual differences compared to the input file. Missing fonts are a typical source of these errors.--pluginpluginsrQawName of plugin to import. Argument may be issued multiple times to import multiple plugins. Plugins may be specified as module names in Python syntax, provided they are installed in the same Python (virtual) environment as ocrmypdf; or you may give the path to the Python file that contains the plugin. Plugins must conform to the specification in the OCRmyPDF documentation.rKrhrHrd Debuggingz4Arguments to help with troubleshooting and debuggingz-kz--keep-temporary-filesz,Keep temporary files (helpful for debugging))r) _PROGRAM_NAMErRawDescriptionHelpFormatter add_argumentrEr%_VERSIONadd_argument_grouprSUPPRESSrfloatr)rR jobcontrolmetadata preprocessing ocrsettingsadvanced debuggings r get_parserris   ! <<&3Fj $  G       6  E)  " 4    - **+@AJ  S!S ! G  i 3K  S!Q 1        dARAR     ((MH "W *35JK #$F ,S7NO--%AM  L     5     .  5  S!T " L++M;WXK ;  < J UAt $4 )((:H      UA  95  ". UAt $'   UA 2   )D  "  ))KI   ;  MrrZF)r[r]add_helpr\rrrQzName of plugin to import.r)NN)rzCallable[[Any], T]rT | Nonerr)r"zMapping[str, int])r@ __future__rrcollections.abcrrtypingrrocrmypdf._defaultsrr rocrmypdf._versionr rr%rr rr'r)ActionrErplugins_only_parserrr&rrrs;"-=<5 Ce* "X,,"B  $^B % cEPU     $ !r