.>g9SrSSKJr SSKrSSKrSSKrSSKJr SSKJ r \ (aSSK J r SSKJ r J r "SS 5r"S S 5r"S S \5rg)u:module: watchdog.utils.dirsnapshot :synopsis: Directory snapshots and comparison. :author: yesudeep@google.com (Yesudeep Mangalapilly) :author: contact@tiger-222.fr (Mickaël Schoentgen) .. ADMONITION:: Where are the moved events? They 'disappeared' This implementation does not take partition boundaries into consideration. It will only work when the directory tree is entirely on the same file system. More specifically, any part of the code that depends on inode numbers can break if partition boundaries are crossed. In these cases, the snapshot diff will represent file/directory movement as created and deleted events. Classes ------- .. autoclass:: DirectorySnapshot :members: :show-inheritance: .. autoclass:: DirectorySnapshotDiff :members: :show-inheritance: .. autoclass:: EmptyDirectorySnapshot :members: :show-inheritance: ) annotationsN)S_ISDIR) TYPE_CHECKING)Iterator)AnyCallablec\rSrSrSrSS.SSjjrSSjrSSjr\SSj5r \SS j5r \SS j5r \SS j5r \SS j5r \SS j5r\SSj5r\SSj5r"SS5rSrg)DirectorySnapshotDiff-a}Compares two directory snapshots and creates an object that represents the difference between the two snapshots. :param ref: The reference directory snapshot. :type ref: :class:`DirectorySnapshot` :param snapshot: The directory snapshot which will be compared with the reference snapshot. :type snapshot: :class:`DirectorySnapshot` :param ignore_device: A boolean indicating whether to ignore the device id or not. By default, a file may be uniquely identified by a combination of its first inode and its device id. The problem is that the device id may (or may not) change between system boots. This problem would cause the DirectorySnapshotDiff to think a file has been deleted and created again but it would be the exact same file. Set to True only if you are sure you will always use the same device. :type ignore_device: :class:`bool` F ignore_devicecURUR- nURUR- nU(aSSjnOSSjnURUR-H9nU"X5U"X'5:wdMURU5 URU5 M; [5n[U5HQnURU5n UR U 5n U (dM.UR U5 URXz45 MS [U5HQnURU5n UR U 5n U (dM.UR U5 URX45 MS [5n URUR-HrnU"X5U"X'5:XdMUR U5UR U5:wd&URU5URU5:wdMaU RU5 Mt UH`upUR U 5UR U 5:wd&URU 5URU 5:wdMOU RU 5 Mb UVs/sHorRU5(dMUPM snUl UVs/sHoqRU5(dMUPM snUl U Vs/sHoqRU5(dMUPM snUl UV Vs/sH upURU 5(dMX4PM" snn Ul [U[UR5- 5Ul[U[UR5- 5Ul[U [UR5- 5Ul[U[UR5- 5Ulgs snfs snfs snfs snn f)Nc*URU5S$)Nrinode directory full_paths .get_inodeRs y1!44c$URU5$Nrrs rrrWs y11r)rDirectorySnapshotr bytes | strreturnzint | tuple[int, int])pathsaddsetrpathremovemtimesizeisdir _dirs_created _dirs_deleted_dirs_modified _dirs_movedlist_files_created_files_deleted_files_modified _files_moved)selfrefsnapshotr createddeletedrr!movedrnew_pathold_pathmodifiedfrmtos r__init__DirectorySnapshotDiff.__init__Fs..399,))hnn,  5  2II.D#y'@@ D! D!/ 7:eLDIIdOE}}U+Hxt$ 4*+ !LDNN4(ExxHxt$ 8*+ !&)UII.D#y'@@ $8>>$#77388D>X]][_M`;` T" / #( Hyy"hnnX&>>#((8BTX`XeXefnXoBo X&#(07Owt..:NdwO/6Jwt))D/dwJ08LIIdOtL7<Ou)3 #ISIuO"7S1C1C-D#DE"7S1C1C-D#DE#Hs43F3F/G$GH T-=-=)>!>?PJLOs0(N?N?O4OO #O 6OOc"UR5$r__repr__r/s r__str__DirectorySnapshotDiff.__str__}}rc SnUR[U5R[UR5[UR 5[UR 5[UR5[UR5[UR5[UR5[UR55 $)Nzz<{0} files(created={1}, deleted={2}, modified={3}, moved={4}), folders(created={5}, deleted={6}, modified={7}, moved={8})>) formattype__name__lenr+r,r-r.r&r'r(r))r/fmts rr>DirectorySnapshotDiff.__repr__s K zz J   ## $ ## $ $$ % !! " "" # "" # ## $   !  rcUR$)z List of files that were created.)r+r?s r files_created#DirectorySnapshotDiff.files_created"""rcUR$)z List of files that were deleted.)r,r?s r files_deleted#DirectorySnapshotDiff.files_deletedrMrcUR$)z!List of files that were modified.)r-r?s rfiles_modified$DirectorySnapshotDiff.files_modifieds###rcUR$)zList of files that were moved. Each event is a two-tuple the first item of which is the path that has been renamed to the second item in the tuple. )r.r?s r files_moved!DirectorySnapshotDiff.files_moveds   rcUR$)z'List of directories that were modified.)r(r?s r dirs_modified#DirectorySnapshotDiff.dirs_modifiedrMrcUR$)zList of directories that were moved. Each event is a two-tuple the first item of which is the path that has been renamed to the second item in the tuple. )r)r?s r dirs_moved DirectorySnapshotDiff.dirs_movedsrcUR$)z&List of directories that were deleted.)r'r?s r dirs_deleted"DirectorySnapshotDiff.dirs_deleted!!!rcUR$)z&List of directories that were created.)r&r?s r dirs_created"DirectorySnapshotDiff.dirs_createdr`rc\rSrSrSrS\R \RSS.S SjjrS Sjr SSjr SS jr S r g )$DirectorySnapshotDiff.ContextManageraContext manager that creates two directory snapshots and a diff object that represents the difference between the two snapshots. :param path: The directory path for which a snapshot should be taken. :type path: ``str`` :param recursive: ``True`` if the entire directory tree should be included in the snapshot; ``False`` otherwise. :type recursive: ``bool`` :param stat: Use custom stat function that returns a stat structure for path. Currently only st_dev, st_ino, st_mode and st_mtime are needed. A function taking a ``path`` as argument which will be called for every entry in the directory tree. :param listdir: Use custom listdir function. For details see ``os.scandir``. :param ignore_device: A boolean indicating whether to ignore the device id or not. By default, a file may be uniquely identified by a combination of its first inode and its device id. The problem is that the device id may (or may not) change between system boots. This problem would cause the DirectorySnapshotDiff to think a file has been deleted and created again but it would be the exact same file. Set to True only if you are sure you will always use the same device. :type ignore_device: :class:`bool` TF) recursivestatlistdirr c@XlX lX0lX@lXPlgr)r!rgrhrir )r/r!rgrhrir s rr:-DirectorySnapshotDiff.ContextManager.__init__sI&NI"L!. rc.UR5Ulgr) get_snapshot pre_snapshotr?s r __enter__.DirectorySnapshotDiff.ContextManager.__enter__s $ 1 1 3D rcUR5Ul[URURURS9Ulg)Nr )rm post_snapshotr rnr diff)r/argss r__exit__-DirectorySnapshotDiff.ContextManager.__exit__s:!%!2!2!4D -!!"""00DIrcj[URURURURS9$)N)r!rgrhri)rr!rgrhrir?s rrm1DirectorySnapshotDiff.ContextManager.get_snapshots+$YY..YY  r)rsr rir!rrrnrgrhN) r!strrgboolrhCallable[[str], os.stat_result]ri-Callable[[str | None], Iterator[os.DirEntry]]r rzrNonerr})rtobjectrr})rr) rF __module__ __qualname____firstlineno____doc__osrhscandirr:rorurm__static_attributes__rrContextManagerresm H#46GGEGZZ"' / / / 2 / C /  / / 4  rr)r&r'r(r)r+r,r-r.N)r0rr1rr rzrr}rry)rzlist[bytes | str])rz%list[tuple[bytes | str, bytes | str]])rFrrrrr:r@r>propertyrKrOrRrUrXr[r^rbrrrrrr r -s:$ @@ @@$@@  @@  @@D "####$$!!##  """"AArr c\rSrSrSrS\R \RS.SSjjrSSjr \ SSj5r SSjr SS jr SS jrSS jrSS jrSS jrSSjrSSjrSSjrSrg)riaA snapshot of stat information of files in a directory. :param path: The directory path for which a snapshot should be taken. :type path: ``str`` :param recursive: ``True`` if the entire directory tree should be included in the snapshot; ``False`` otherwise. :type recursive: ``bool`` :param stat: Use custom stat function that returns a stat structure for path. Currently only st_dev, st_ino, st_mode and st_mtime are needed. A function taking a ``path`` as argument which will be called for every entry in the directory tree. :param listdir: Use custom listdir function. For details see ``os.scandir``. T)rgrhricfX lX0lX@l0Ul0UlURU5nXPRU'XRUR UR 4'URU5H9upeUR UR 4nX`RU'XPRU'M; gr)rgrhri _stat_info_inode_to_pathst_inost_devwalk)r/r!rgrhristpis rr:DirectorySnapshot.__init__&s#  =?BD YYt_ "6:RYY 23YYt_EABII&A%&   "!#OOA %rc#0# URU5Vs/sH,n[RRXR5PM. nn/nUHMn[R"[ 5 X`RU54nURU5 Uv SSS5 MO UR(abUH[upx[R"[5 [!UR"5(aUR%U5ShvN SSS5 M] ggs snf![ aHnUR [ R[ R[ R4;aSnAgeSnAff=f!,(df  GM/=fN!,(df  M=f7fr)rirr!joinnameOSErrorerrnoENOENTENOTDIREINVAL contextlibsuppressrhappendrgPermissionErrorrst_moder) r/rootentryreentriesrr!rs rrDirectorySnapshot.walk>s% AEdASTASRWW\\$ 3ASETA$$W-IIaL)u% .- >>#((9rzz**#'99T?22:9$ %U  ww5<< EE .-3:9sFD3D D !F-(E/>F/FFFFD E,$=E'!F&E''E,,F/ E? 9 FF F FcH[URR55$)z,Set of file/directory paths in the snapshot.)r rkeysr?s rrDirectorySnapshot.pathsXs4??'')**rc8URRU5$)zDirectorySnapshot.__repr__s4??##r)rrrirgrhN) r!ryrgrzrhr{rir|rr})rryrz$Iterator[tuple[str, os.stat_result]])rzset[bytes | str])rtuple[int, int]rzbytes | str | None)r!rrr)r!rrrz)r!rrfloat)r!rrint)r!rrzos.stat_result)rrrr r)rFrrrrrrhrr:rrrr!rr%r#r$rrr@r>rrrrrrs202AC $$ $ . $ ? $ $034++,& 6.- %=$rrcJ\rSrSrSrSSjr\S Sj5r\S Sj5r Sr g) EmptyDirectorySnapshotizClass to implement an empty snapshot. This is used together with DirectorySnapshot and DirectorySnapshotDiff in order to get all the files/folders in the directory as created. cgrrr?s rr:EmptyDirectorySnapshot.__init__s rcg)zMock up method to return the path of the received inode. As the snapshot is intended to be empty, it always returns None. :returns: None. Nr)_s rr!EmptyDirectorySnapshot.paths rc[5$)zMock up method to return a set of file/directory paths in the snapshot. As the snapshot is intended to be empty, it always returns an empty set. :returns: An empty set. )r r?s rrEmptyDirectorySnapshot.pathss u rrNr~)rrrr})rr ) rFrrrrr: staticmethodr!rrrrrrrrs4  rr)r __future__rrrrrhrtypingrcollections.abcrrrr rrrrrrsN>#  ($``Fz$z$z.r