%jZddlmZmZmZddlmZGddZGddZdS) )AnyBinaryIOOptional) StreamInfoceZdZdZdddedeefdZedefdZej defd Zdefd Z dS) DocumentConverterResultz0The result of converting a document to Markdown.N)titlemarkdownr c"||_||_dS)aN Initialize the DocumentConverterResult. The only required parameter is the converted Markdown text. The title, and any other metadata that may be added in the future, are optional. Parameters: - markdown: The converted Markdown text. - title: Optional title of the document. N)r r )selfr r s b/home/rurouni/.hermes/hermes-agent/venv/lib/python3.11/site-packages/markitdown/_base_converter.py__init__z DocumentConverterResult.__init__s !  returnc|jS)]Soft-deprecated alias for `markdown`. New code should migrate to using `markdown` or __str__.r r s r text_contentz$DocumentConverterResult.text_contents }rc||_dS)rNr)r r s rrz$DocumentConverterResult.text_content s! rc|jS)z#Return the converted Markdown text.rrs r__str__zDocumentConverterResult.__str__%s }r) __name__ __module__ __qualname____doc__strrrpropertyrsetterrrrr r s:: $ } &cX!S!!!!rr cBeZdZdZdedededefdZdededede fdZ dS) DocumentConverterz.Abstract superclass of all DocumentConverters. file_stream stream_infokwargsrc Ltdt|jd)aY Return a quick determination on if the converter should attempt converting the document. This is primarily based `stream_info` (typically, `stream_info.mimetype`, `stream_info.extension`). In cases where the data is retrieved via HTTP, the `steam_info.url` might also be referenced to make a determination (e.g., special converters for Wikipedia, YouTube etc). Finally, it is conceivable that the `stream_info.filename` might be used to in cases where the filename is well-known (e.g., `Dockerfile`, `Makefile`, etc) NOTE: The method signature is designed to match that of the convert() method. This provides some assurance that, if accepts() returns True, the convert() method will also be able to handle the document. IMPORTANT: In rare cases, (e.g., OutlookMsgConverter) we need to read more from the stream to make a final determination. Read operations inevitably advances the position in file_stream. In these case, the position MUST be reset it MUST be reset before returning. This is because the convert() method may be called immediately after accepts(), and will expect the file_stream to be at the original position. E.g., cur_pos = file_stream.tell() # Save the current position data = file_stream.read(100) # ... peek at the first 100 bytes, etc. file_stream.seek(cur_pos) # Reset the position to the original position Parameters: - file_stream: The file-like object to convert. Must support seek(), tell(), and read() methods. - stream_info: The StreamInfo object containing metadata about the file (mimetype, extension, charset, set) - kwargs: Additional keyword arguments for the converter. Returns: - bool: True if the converter can handle the document, False otherwise. zThe subclass, zS, must implement the accepts() method to determine if they can handle the document.)NotImplementedErrortyperr r$r%r&s racceptszDocumentConverter.accepts-s:F" FT$ZZ0 F F F   rc td)a Convert a document to Markdown text. Parameters: - file_stream: The file-like object to convert. Must support seek(), tell(), and read() methods. - stream_info: The StreamInfo object containing metadata about the file (mimetype, extension, charset, set) - kwargs: Additional keyword arguments for the converter. Returns: - DocumentConverterResult: The result of the conversion, which includes the title and markdown content. Raises: - FileConversionException: If the mimetype is recognized, but the conversion fails for some other reason. - MissingDependencyException: If the converter requires a dependency that is not installed. z%Subclasses must implement this method)r(r*s rconvertzDocumentConverter.convertTs*""IJJJrN) rrrrrrrboolr+r r-r!rrr#r#*s88% %  %  %  % % % % NKK K K ! KKKKKKrr#N)typingrrr _stream_inforr r#r!rrr1s**********$$$$$$""""""""J?K?K?K?K?K?K?K?K?K?Kr