df{IdZddlZddlZddlZddlZddlZddlmZmZddlm Z ddl m Z m Z m Z ddlmZmZmZmZmZmZGdde ZGd d eZGd d ZGd dZGddZdZy)zDGridFS implementation for Motor, an asynchronous driver for MongoDB.N)DEFAULT_CHUNK_SIZE grid_file) docstrings)AgnosticCollectionAgnosticCursorAgnosticDatabase) AsyncCommand AsyncReadDelegateMethodReadOnlyPropertycoroutine_annotationcreate_class_with_frameworkcHeZdZdZej ZeZfdZ xZ S)AgnosticGridOutCursorMotorGridOutCursorct|}|r9tt|j|j }||j |Sy)z5**DEPRECATED** - Get next GridOut object from cursor.)delegateN)super next_objectrAgnosticGridOut _framework __module__ collection)selfgrid_outgrid_out_class __class__s K/home/api-vastappli/venv/lib/python3.12/site-packages/motor/motor_gridfs.pyrz!AgnosticGridOutCursor.next_object+sF7&( 8$//N"$//HE E) __name__r __qualname____motor_class_name__gridfs GridOutCursor__delegate_class__r _Cursor__dier __classcell__)rs@rrr$s(/-- >L  rrceZdZdZdZy)MotorGridOutPropertyz.fget>sG<<%%nn55&(12 3<<3 3r)r5doc)r2r%__doc__property)rclsr4r5r6s ` rcreate_attributez%MotorGridOutProperty.create_attribute=s/ 4c,,i8@@Ts++rN)r rr!r7r:rrr)r):s F ,rr)cneZdZdZdZej ZeZ e Z e Z e Z e Ze Ze Ze Ze Ze ZeZeZeZeZeZeZeZe ZeZ d dZdZ dZ!dZ"e#dZ$d Z%d Z&y) raClass to read data out of GridFS. MotorGridOut supports the same attributes as PyMongo's :class:`~gridfs.grid_file.GridOut`, such as ``_id``, ``content_type``, etc. You don't need to instantiate this class directly - use the methods provided by :class:`~motor.MotorGridFSBucket`. If it **is** instantiated directly, call :meth:`open`, :meth:`read`, or :meth:`readline` before accessing its attributes. MotorGridOutNctt|j|j}t ||st d|z|r||_n$|j|j ||||_|j|_ y)Nz>First argument to MotorGridOut must be MotorCollection, not %r)session) rrrr isinstance TypeErrorrr% get_io_loopio_loop)rroot_collectionfile_id file_documentrr?collection_classs r__init__zAgnosticGridOut.__init__os7  /+;<*,;<  $DM 33(('='4DM'224 rc|SNr;rs r __aiter__zAgnosticGridOut.__aiter__s rcZK|jd{}|r|St7wrJ) readchunkStopAsyncIteration)rchunks r __anext__zAgnosticGridOut.__anext__s+nn&& L ""'s +)+c|jjs"tjj d|zt |j|Sr,r-)ritems r __getattr__zAgnosticGridOut.__getattr__sB}}""..11TW[[ t}}d++rct|jj|j|j|S)aERetrieve this file's attributes from the server. Returns a Future. .. versionchanged:: 2.0 No longer accepts a callback argument. .. versionchanged:: 0.2 :class:`~motor.MotorGridOut` now opens itself on demand, calling ``open`` explicitly is rarely needed. )rchain_return_value _ensure_filerBrKs ropenzAgnosticGridOut.opens011$2C2C2EtGWGWGY[_``rc|jSrJrCrKs rrBzAgnosticGridOut.get_io_loop ||rcKd}||jkrc|j|jd{}|j||j |t |z }||jkrbyy7Ew)aWrite the contents of this file to a :class:`tornado.web.RequestHandler`. This method calls :meth:`~tornado.web.RequestHandler.flush` on the RequestHandler, so ensure all headers have already been set. For a more complete example see the implementation of :class:`~motor.web.GridFSHandler`. .. code-block:: python class FileHandler(tornado.web.RequestHandler): @tornado.web.asynchronous @gen.coroutine def get(self, filename): db = self.settings["db"] fs = await motor.MotorGridFSBucket(db()) try: gridout = await fs.open_download_stream_by_name(filename) except gridfs.NoFile: raise tornado.web.HTTPError(404) self.set_header("Content-Type", gridout.content_type) self.set_header("Content-Length", gridout.length) await gridout.stream_to_handler(self) self.finish() .. seealso:: Tornado `RequestHandler `_ rN)lengthread chunk_sizewriteflushlen)rrequest_handlerwrittenrPs rstream_to_handlerz!AgnosticGridOut.stream_to_handlersi8 #))DOO44E  ! !% (  ! ! # s5z !G #4s0A:A8AA:6A:)NNNN)'r rr!r7r"r#GridOutr%r rWr)_idaliasesr_close content_typefilenamer]metadatanamer r^r readablerNreadlineseekseekabletell upload_dater`rHrLrQrTr rXrBrer;rrrrKs *>L  C"$G%'J "E')L#%H ! #F#%H  !D ;DH I{H  DH  D&(K  EY]5,# , a a%"rrceZdZdZej ZeZe Z e Z e Z e Ze Ze Ze Ze Ze ZeZeZeZe Ze j1dZeZe j1dZe dZe ddZd dZd Zd Z d Z!y) AgnosticGridIn MotorGridInr=__exit__ __setattr__a Set an arbitrary metadata attribute on the file. Stores value on the server as a key-value pair within the file document once the file is closed. If the file is already closed, calling :meth:`set` will immediately update the file document on the server. Metadata set on the file appears as attributes on a :class:`~motor.MotorGridOut` object created from the file. :Parameters: - `name`: Name of the attribute, will be stored as a key in the file document on the server - `value`: Value of the attribute )r4r6Nc tt|j|j}t ||st d|z|j |_|xs|j|jfd|i||_ y)a Class to write data to GridFS. Application developers should not generally need to instantiate this class - see :meth:`~motor.MotorGridFSBucket.open_upload_stream`. Any of the file level options specified in the `GridFS Spec `_ may be passed as keyword arguments. Any additional keyword arguments will be set as additional fields on the file document. Valid keyword arguments include: - ``"_id"``: unique ID for this file (default: :class:`~bson.objectid.ObjectId`) - this ``"_id"`` must not have already been used for another file - ``"filename"``: human name for the file - ``"contentType"`` or ``"content_type"``: valid mime-type for the file - ``"chunkSize"`` or ``"chunk_size"``: size of each of the chunks, in bytes (default: 256 kb) - ``"encoding"``: encoding used for this file. In Python 2, any :class:`unicode` that is written to the file will be converted to a :class:`str`. In Python 3, any :class:`str` that is written to the file will be converted to :class:`bytes`. :Parameters: - `root_collection`: root collection to write to - `session` (optional): a :class:`~pymongo.client_session.ClientSession` to use for all commands - `**kwargs` (optional): file level options (see above) .. versionchanged:: 3.0 Removed support for the `disable_md5` parameter (to match the GridIn class in PyMongo). .. versionchanged:: 0.2 ``open`` method removed, no longer needed. z=First argument to MotorGridIn must be MotorCollection, not %rr?N) rrrrr@rArBrCr%r)rrDrr?kwargsrGs rrHzAgnosticGridIn.__init__sV7  /+;<ORaa '224   $;D$;$;  $ $% .5% 9?%  rcK|SwrJr;rKs r __aenter__zAgnosticGridIn.__aenter__3s  scFK|j|||d{y7wrJ)_exit)rexc_typeexc_valexc_tbs r __aexit__zAgnosticGridIn.__aexit__6sjj7F333s !!c|jSrJrZrKs rrBzAgnosticGridIn.get_io_loop9r[r)NN)"r rr!r"r#GridInr%r rTr rgr abortr_closedrirjrkr]rmr^rnrqrsunwrapr` writeable writelinesr~setrHr|rrBr;rrrurus( "K  C NE!#J  F NE#%L!H  F  D  DHH"$K N ! !. 1E I&&~6J  $E   C$8 v4rruceZdZdZej ZeejZ eejZ eejZeejj!ej"Zeej&j!ej"Zeej,j!ej.Zeej2j!ej.Zeej6Zeej:Zeej>Z de!dddfdZ"dZ#dZdZ$y) AgnosticGridFSBucketMotorGridFSBucket)r6fsNc|tjdtd|}tt|j |j }t||std|jd||j|_ |j||||_ |j|j|||||_y) aCreate a handle to a GridFS bucket. Raises :exc:`~pymongo.errors.ConfigurationError` if `write_concern` is not acknowledged. This class conforms to the `GridFS API Spec `_ for MongoDB drivers. :Parameters: - `database`: database to use. - `bucket_name` (optional): The name of the bucket. Defaults to 'fs'. - `chunk_size_bytes` (optional): The chunk size in bytes. Defaults to 255KB. - `write_concern` (optional): The :class:`~pymongo.write_concern.WriteConcern` to use. If ``None`` (the default) db.write_concern is used. - `read_preference` (optional): The read preference to use. If ``None`` (the default) db.read_preference is used. - `collection` (optional): Deprecated, an alias for `bucket_name` that exists solely to provide backwards compatibility. .. versionchanged:: 3.0 Removed support for the `disable_md5` parameter (to match the GridFSBucket class in PyMongo). .. versionchanged:: 2.1 Added support for the `bucket_name`, `chunk_size_bytes`, `write_concern`, and `read_preference` parameters. Deprecated the `collection` parameter which is now an alias to `bucket_name` (to match the GridFSBucket class in PyMongo). .. versionadded:: 1.0 .. mongodoc:: gridfs NzCthe "collection" parameter is deprecated, use "bucket_name" instead) stacklevelzFirst argument to z must be MotorDatabase, not ) write_concernread_preference)chunk_size_bytesrr)warningswarnDeprecationWarningrrrrr@rArrBrCget_collectionrr%r)rdatabase bucket_namerrrrdb_classs rrHzAgnosticGridFSBucket.__init__TsX  ! MMU"  %K./?RVRaRab(H-$T^^$44QRZQ]^  ++- "11 }o2 //    -'+ 0  rc|jSrJrZrKs rrBz AgnosticGridFSBucket.get_io_loopr[rc|jtjur9tt|j |j }||j|S|jtjur9tt|j |j }||j|S|jtjur9tt|j |j }|||jSy)N)rDr)cursorr) rrrrrurrrrfrr#r$r)rr3 grid_in_classrs rwrapzAgnosticGridFSBucket.wraps ==I,, ,7M!3O O ]]i// /8$//N"$//CP P ]]f22 28%tN"I I 3rc|jj|i|}tt|j|j }|||j S)aBFind and return the files collection documents that match ``filter``. Returns a cursor that iterates across files matching arbitrary queries on the files collection. Can be combined with other modifiers for additional control. For example:: cursor = bucket.find({"filename": "lisa.txt"}, no_cursor_timeout=True) while (await cursor.fetch_next): grid_out = cursor.next_object() data = await grid_out.read() This iterates through all versions of "lisa.txt" stored in GridFS. Note that setting no_cursor_timeout to True may be important to prevent the cursor from timing out during long multi-file processing work. As another example, the call:: most_recent_three = fs.find().sort("uploadDate", -1).limit(3) would return a cursor to the three most recently uploaded files in GridFS. Follows a similar interface to :meth:`~motor.MotorCollection.find` in :class:`~motor.MotorCollection`. :Parameters: - `filter`: Search query. - `batch_size` (optional): The number of documents to return per batch. - `limit` (optional): The maximum number of documents to return. - `no_cursor_timeout` (optional): The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to True prevent that. - `skip` (optional): The number of documents to skip before returning. - `sort` (optional): The order by which to sort results. Defaults to None. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`, created with :meth:`~MotorClient.start_session`. If a :class:`~pymongo.client_session.ClientSession` is passed to :meth:`find`, all returned :class:`MotorGridOut` instances are associated with that session. .. versionchanged:: 1.2 Added session parameter. )rfindrrrrr)rargsrzrgrid_out_cursors rrzAgnosticGridFSBucket.findsLj$##T4V45 !4??DOO vt77r)%r rr!r"r# GridFSBucketr%r rgridfs_delete_docdeletegridfs_download_to_stream_docdownload_to_stream%gridfs_download_to_stream_by_name_docdownload_to_stream_by_namegridfs_open_download_stream_docrrfopen_download_stream'gridfs_open_download_stream_by_name_docopen_download_stream_by_namer gridfs_open_upload_stream_docropen_upload_stream%gridfs_open_upload_stream_with_id_docopen_upload_stream_with_idgridfs_rename_docrenamegridfs_upload_from_stream_docupload_from_stream%gridfs_upload_from_stream_with_id_docupload_from_stream_with_idrrHrBrr;rrrr=s6.,, j:: ;F%**R*RS!-*2b2b!c'J,V,VW\\$0  > >$ d6>>!(J,T,TUZZ "0  < <" d6==j:: ;F%**R*RS!-*2b2b!c +E NJ,:8rrc\tjt|jj d}|j t|j j d|j t|jj d|jS)zCompute the effective hash of a GridOut object for use with an Etag header. Create a FIPS-compliant Etag HTTP header hash using sha256 We use the _id + length + upload_date as a proxy for uniqueness to avoid reading the entire file. utf8) hashlibsha256strrgencodeupdater]rs hexdigest)gridout grid_hashs r _hash_gridoutrs{s7;;/66v>?I S(//78 S,,-44V<=     r)r7rrr#r/pymongo.errorsrrmotorr motor.corerrrmotor.metaprogrammingr r r r r rrr)rrurrr;rrrsuK 0KKN,,+,"B"B"JjjZq8q8h !r