py2docfx 0.1.15.dev2025736__py3-none-any.whl → 0.1.15.dev2038852__py3-none-any.whl

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/BackupSeek_streamheaders.py

@@ -1,137 +0,0 @@
-## demonstrates using BackupSeek to enumerate data streams for a file
-import struct
-
-import pythoncom
-import pywintypes
-import win32api
-import win32con
-import win32file
-from win32com import storagecon
-
-stream_types = {
-    win32con.BACKUP_DATA: "Standard data",
-    win32con.BACKUP_EA_DATA: "Extended attribute data",
-    win32con.BACKUP_SECURITY_DATA: "Security descriptor data",
-    win32con.BACKUP_ALTERNATE_DATA: "Alternative data streams",
-    win32con.BACKUP_LINK: "Hard link information",
-    win32con.BACKUP_PROPERTY_DATA: "Property data",
-    win32con.BACKUP_OBJECT_ID: "Objects identifiers",
-    win32con.BACKUP_REPARSE_DATA: "Reparse points",
-    win32con.BACKUP_SPARSE_BLOCK: "Sparse file",
-}
-
-tempdir = win32api.GetTempPath()
-tempfile = win32api.GetTempFileName(tempdir, "bkr")[0]
-print("Filename:", tempfile)
-
-f = open(tempfile, "w")
-f.write("some random junk" + "x" * 100)
-f.close()
-
-f = open(tempfile + ":streamdata", "w")
-f.write("data written to alternate stream" + "y" * 100)
-f.close()
-
-f = open(tempfile + ":anotherstream", "w")
-f.write("z" * 200)
-f.close()
-
-## add Summary Information, which is stored as a separate stream
-m = storagecon.STGM_READWRITE | storagecon.STGM_SHARE_EXCLUSIVE | storagecon.STGM_DIRECT
-pss = pythoncom.StgOpenStorageEx(
-    tempfile, m, storagecon.STGFMT_FILE, 0, pythoncom.IID_IPropertySetStorage, None
-)
-ps = pss.Create(
-    pythoncom.FMTID_SummaryInformation,
-    pythoncom.IID_IPropertyStorage,
-    0,
-    storagecon.STGM_READWRITE | storagecon.STGM_SHARE_EXCLUSIVE,
-)
-ps.WriteMultiple(
-    (storagecon.PIDSI_KEYWORDS, storagecon.PIDSI_COMMENTS), ("keywords", "comments")
-)
-ps = None
-pss = None
-
-sa = pywintypes.SECURITY_ATTRIBUTES()
-sa.bInheritHandle = False
-h = win32file.CreateFile(
-    tempfile,
-    win32con.GENERIC_ALL,
-    win32con.FILE_SHARE_READ,
-    sa,
-    win32con.OPEN_EXISTING,
-    win32file.FILE_FLAG_BACKUP_SEMANTICS,
-    None,
-)
-
-
-""" stream header:
-typedef struct _WIN32_STREAM_ID {
-    DWORD dwStreamId;  DWORD dwStreamAttributes;  LARGE_INTEGER Size;
-    DWORD dwStreamNameSize;  WCHAR cStreamName[ANYSIZE_ARRAY];
-}
-"""
-
-win32_stream_id_format = "LLQL"
-win32_stream_id_size = struct.calcsize(win32_stream_id_format)
-
-
-def parse_stream_header(h, ctxt, data):
-    stream_type, stream_attributes, stream_size, stream_name_size = struct.unpack(
-        win32_stream_id_format, data
-    )
-    print(
-        "\nType:",
-        stream_type,
-        stream_types[stream_type],
-        "Attributes:",
-        stream_attributes,
-        "Size:",
-        stream_size,
-        "Name len:",
-        stream_name_size,
-    )
-    if stream_name_size > 0:
-        ## ??? sdk says this size is in characters, but it appears to be number of bytes ???
-        bytes_read, stream_name_buf, ctxt = win32file.BackupRead(
-            h, stream_name_size, None, False, True, ctxt
-        )
-        stream_name = pywintypes.UnicodeFromRaw(stream_name_buf[:])
-    else:
-        stream_name = "Unnamed"
-    print("Name:" + stream_name)
-    return (
-        ctxt,
-        stream_type,
-        stream_attributes,
-        stream_size,
-        stream_name_size,
-        stream_name,
-    )
-
-
-ctxt = 0
-win32_stream_id_buf = (
-    None  ## gets rebound to a writable buffer on first call and reused
-)
-while 1:
-    bytes_read, win32_stream_id_buf, ctxt = win32file.BackupRead(
-        h, win32_stream_id_size, win32_stream_id_buf, False, True, ctxt
-    )
-    if bytes_read == 0:
-        break
-    (
-        ctxt,
-        stream_type,
-        stream_attributes,
-        stream_size,
-        stream_name_size,
-        stream_name,
-    ) = parse_stream_header(h, ctxt, win32_stream_id_buf[:])
-    if stream_size > 0:
-        bytes_moved = win32file.BackupSeek(h, stream_size, ctxt)
-        print("Moved: ", bytes_moved)
-
-win32file.BackupRead(h, win32_stream_id_size, win32_stream_id_buf, True, True, ctxt)
-win32file.CloseHandle(h)

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/CopyFileEx.py

@@ -1,57 +0,0 @@
-import win32api
-import win32file
-
-
-def ProgressRoutine(
-    TotalFileSize,
-    TotalBytesTransferred,
-    StreamSize,
-    StreamBytesTransferred,
-    StreamNumber,
-    CallbackReason,
-    SourceFile,
-    DestinationFile,
-    Data,
-):
-    print(Data)
-    print(
-        TotalFileSize,
-        TotalBytesTransferred,
-        StreamSize,
-        StreamBytesTransferred,
-        StreamNumber,
-        CallbackReason,
-        SourceFile,
-        DestinationFile,
-    )
-    ##if TotalBytesTransferred > 100000:
-    ##    return win32file.PROGRESS_STOP
-    return win32file.PROGRESS_CONTINUE
-
-
-temp_dir = win32api.GetTempPath()
-fsrc = win32api.GetTempFileName(temp_dir, "cfe")[0]
-fdst = win32api.GetTempFileName(temp_dir, "cfe")[0]
-print(fsrc, fdst)
-
-f = open(fsrc, "w")
-f.write("xxxxxxxxxxxxxxxx\n" * 32768)
-f.close()
-## add a couple of extra data streams
-f = open(fsrc + ":stream_y", "w")
-f.write("yyyyyyyyyyyyyyyy\n" * 32768)
-f.close()
-f = open(fsrc + ":stream_z", "w")
-f.write("zzzzzzzzzzzzzzzz\n" * 32768)
-f.close()
-
-operation_desc = "Copying " + fsrc + " to " + fdst
-win32file.CopyFileEx(
-    fsrc,
-    fdst,
-    ProgressRoutine,
-    Data=operation_desc,
-    Cancel=False,
-    CopyFlags=win32file.COPY_FILE_RESTARTABLE,
-    Transaction=None,
-)

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/CreateFileTransacted_MiniVersion.py

@@ -1,122 +0,0 @@
-"""
-This demonstrates the creation of miniversions of a file during a transaction.
-The FSCTL_TXFS_CREATE_MINIVERSION control code saves any changes to a new
-miniversion (effectively a savepoint within a transaction).
-"""
-
-import os
-import struct
-
-import win32api
-import win32con
-import win32file
-import win32transaction
-import winerror
-import winioctlcon
-
-
-def demo():
-    """
-    Definition of buffer used with FSCTL_TXFS_CREATE_MINIVERSION:
-    typedef struct _TXFS_CREATE_MINIVERSION_INFO{
-        USHORT StructureVersion;
-        USHORT StructureLength;
-        ULONG BaseVersion;
-        USHORT MiniVersion;}
-    """
-    buf_fmt = "HHLH0L"  ## buffer size must include struct padding
-    buf_size = struct.calcsize(buf_fmt)
-
-    tempdir = win32api.GetTempPath()
-    tempfile = win32api.GetTempFileName(tempdir, "cft")[0]
-    print("Demonstrating transactions on tempfile", tempfile)
-    f = open(tempfile, "w")
-    f.write("This is original file.\n")
-    f.close()
-
-    trans = win32transaction.CreateTransaction(
-        Description="Test creating miniversions of a file"
-    )
-    hfile = win32file.CreateFileW(
-        tempfile,
-        win32con.GENERIC_READ | win32con.GENERIC_WRITE,
-        win32con.FILE_SHARE_READ | win32con.FILE_SHARE_WRITE,
-        None,
-        win32con.OPEN_EXISTING,
-        0,
-        None,
-        Transaction=trans,
-    )
-
-    win32file.WriteFile(hfile, b"This is first miniversion.\n")
-    buf = win32file.DeviceIoControl(
-        hfile, winioctlcon.FSCTL_TXFS_CREATE_MINIVERSION, None, buf_size, None
-    )
-    struct_ver, struct_len, base_ver, ver_1 = struct.unpack(buf_fmt, buf)
-
-    win32file.SetFilePointer(hfile, 0, win32con.FILE_BEGIN)
-    win32file.WriteFile(hfile, b"This is second miniversion!\n")
-    buf = win32file.DeviceIoControl(
-        hfile, winioctlcon.FSCTL_TXFS_CREATE_MINIVERSION, None, buf_size, None
-    )
-    struct_ver, struct_len, base_ver, ver_2 = struct.unpack(buf_fmt, buf)
-    hfile.Close()
-
-    ## miniversions can't be opened with write access
-    hfile_0 = win32file.CreateFileW(
-        tempfile,
-        win32con.GENERIC_READ,
-        win32con.FILE_SHARE_READ | win32con.FILE_SHARE_WRITE,
-        None,
-        win32con.OPEN_EXISTING,
-        0,
-        None,
-        Transaction=trans,
-        MiniVersion=base_ver,
-    )
-    print("version:", base_ver, win32file.ReadFile(hfile_0, 100))
-    hfile_0.Close()
-
-    hfile_1 = win32file.CreateFileW(
-        tempfile,
-        win32con.GENERIC_READ,
-        win32con.FILE_SHARE_READ | win32con.FILE_SHARE_WRITE,
-        None,
-        win32con.OPEN_EXISTING,
-        0,
-        None,
-        Transaction=trans,
-        MiniVersion=ver_1,
-    )
-    print("version:", ver_1, win32file.ReadFile(hfile_1, 100))
-    hfile_1.Close()
-
-    hfile_2 = win32file.CreateFileW(
-        tempfile,
-        win32con.GENERIC_READ,
-        win32con.FILE_SHARE_READ | win32con.FILE_SHARE_WRITE,
-        None,
-        win32con.OPEN_EXISTING,
-        0,
-        None,
-        Transaction=trans,
-        MiniVersion=ver_2,
-    )
-    print("version:", ver_2, win32file.ReadFile(hfile_2, 100))
-    hfile_2.Close()
-
-    ## MiniVersions are destroyed when transaction is committed or rolled back
-    win32transaction.CommitTransaction(trans)
-
-    os.unlink(tempfile)
-
-
-if __name__ == "__main__":
-    # When run on CI, this fails with NOT_SUPPORTED, so don't have that cause "failure"
-    try:
-        demo()
-    except win32file.error as e:
-        if e.winerror == winerror.ERROR_NOT_SUPPORTED:
-            print("These features are not supported by this filesystem.")
-        else:
-            raise

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/EvtFormatMessage.py

@@ -1,83 +0,0 @@
-import sys
-
-import win32evtlog
-
-
-def main():
-    path = "System"
-    num_events = 5
-    if len(sys.argv) > 2:
-        path = sys.argv[1]
-        num_events = int(sys.argv[2])
-    elif len(sys.argv) > 1:
-        path = sys.argv[1]
-
-    query = win32evtlog.EvtQuery(path, win32evtlog.EvtQueryForwardDirection)
-    events = win32evtlog.EvtNext(query, num_events)
-    context = win32evtlog.EvtCreateRenderContext(win32evtlog.EvtRenderContextSystem)
-
-    for i, event in enumerate(events, 1):
-        result = win32evtlog.EvtRender(
-            event, win32evtlog.EvtRenderEventValues, Context=context
-        )
-
-        print(f"Event {i}")
-
-        level_value, level_variant = result[win32evtlog.EvtSystemLevel]
-        if level_variant != win32evtlog.EvtVarTypeNull:
-            if level_value == 1:
-                print("    Level: CRITICAL")
-            elif level_value == 2:
-                print("    Level: ERROR")
-            elif level_value == 3:
-                print("    Level: WARNING")
-            elif level_value == 4:
-                print("    Level: INFO")
-            elif level_value == 5:
-                print("    Level: VERBOSE")
-            else:
-                print("    Level: UNKNOWN")
-
-        time_created_value, time_created_variant = result[
-            win32evtlog.EvtSystemTimeCreated
-        ]
-        if time_created_variant != win32evtlog.EvtVarTypeNull:
-            print(f"    Timestamp: {time_created_value.isoformat()}")
-
-        computer_value, computer_variant = result[win32evtlog.EvtSystemComputer]
-        if computer_variant != win32evtlog.EvtVarTypeNull:
-            print(f"    FQDN: {computer_value}")
-
-        provider_name_value, provider_name_variant = result[
-            win32evtlog.EvtSystemProviderName
-        ]
-        if provider_name_variant != win32evtlog.EvtVarTypeNull:
-            print(f"    Provider: {provider_name_value}")
-
-            try:
-                metadata = win32evtlog.EvtOpenPublisherMetadata(provider_name_value)
-            # pywintypes.error: (2, 'EvtOpenPublisherMetadata', 'The system cannot find the file specified.')
-            except Exception:
-                pass
-            else:
-                try:
-                    message = win32evtlog.EvtFormatMessage(
-                        metadata, event, win32evtlog.EvtFormatMessageEvent
-                    )
-                # pywintypes.error: (15027, 'EvtFormatMessage: allocated 0, need buffer of size 0', 'The message resource is present but the message was not found in the message table.')
-                except Exception:
-                    pass
-                else:
-                    try:
-                        print(f"    Message: {message}")
-                    except UnicodeEncodeError:
-                        # Obscure error when run under subprocess.Popen(), presumably due to
-                        # not knowing the correct encoding for the console.
-                        # > UnicodeEncodeError: \'charmap\' codec can\'t encode character \'\\u200e\' in position 57: character maps to <undefined>\r\n'
-                        # Can't reproduce when running manually, so it seems more a subprocess.Popen()
-                        # than ours:
-                        print(f" Failed to decode: {message!r}")
-
-
-if __name__ == "__main__":
-    main()

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/EvtSubscribe_pull.py

@@ -1,28 +0,0 @@
-## Demonstrates how to create a "pull" subscription
-import win32con
-import win32event
-import win32evtlog
-
-query_text = '*[System[Provider[@Name="Microsoft-Windows-Winlogon"]]]'
-
-h = win32event.CreateEvent(None, 0, 0, None)
-s = win32evtlog.EvtSubscribe(
-    "System",
-    win32evtlog.EvtSubscribeStartAtOldestRecord,
-    SignalEvent=h,
-    Query=query_text,
-)
-
-while 1:
-    while 1:
-        events = win32evtlog.EvtNext(s, 10)
-        if len(events) == 0:
-            break
-        ##for event in events:
-        ##	print(win32evtlog.EvtRender(event, win32evtlog.EvtRenderEventXml))
-        print("retrieved %s events" % len(events))
-    while 1:
-        print("waiting...")
-        w = win32event.WaitForSingleObjectEx(h, 2000, True)
-        if w == win32con.WAIT_OBJECT_0:
-            break

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/EvtSubscribe_push.py

@@ -1,32 +0,0 @@
-## Demonstrates a "push" subscription with a callback function
-from __future__ import annotations
-
-from time import sleep
-
-import win32evtlog
-
-query_text = '*[System[Provider[@Name="Microsoft-Windows-Winlogon"]]]'
-
-
-def c(reason, context, evt):
-    if reason == win32evtlog.EvtSubscribeActionError:
-        print("EvtSubscribeActionError")
-    elif reason == win32evtlog.EvtSubscribeActionDeliver:
-        print("EvtSubscribeActionDeliver")
-    else:
-        print("??? Unknown action ???", reason)
-    context.append(win32evtlog.EvtRender(evt, win32evtlog.EvtRenderEventXml))
-    return 0
-
-
-evttext: list[str] = []
-s = win32evtlog.EvtSubscribe(
-    "System",
-    win32evtlog.EvtSubscribeStartAtOldestRecord,
-    Query="*",
-    Callback=c,
-    Context=evttext,
-)
-
-sleep(0.001)
-print("\n".join(evttext))

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/FileSecurityTest.py

@@ -1,137 +0,0 @@
-# Contributed by Kelly Kranabetter.
-import os
-import sys
-
-import ntsecuritycon
-import pywintypes
-import win32security
-import winerror
-
-# get security information
-# name=r"c:\autoexec.bat"
-# name= r"g:\!workgrp\lim"
-name = sys.argv[0]
-
-if not os.path.exists(name):
-    print(name, "does not exist!")
-    sys.exit()
-
-print("On file ", name, "\n")
-
-# get owner SID
-print("OWNER")
-try:
-    sd = win32security.GetFileSecurity(name, win32security.OWNER_SECURITY_INFORMATION)
-    sid = sd.GetSecurityDescriptorOwner()
-    print("  ", win32security.LookupAccountSid(None, sid))
-except pywintypes.error as exc:
-    # in automation and network shares we see:
-    # pywintypes.error: (1332, 'LookupAccountName', 'No mapping between account names and security IDs was done.')
-    if exc.winerror != winerror.ERROR_NONE_MAPPED:
-        raise
-    print("No owner information is available")
-
-# get group SID
-try:
-    print("GROUP")
-    sd = win32security.GetFileSecurity(name, win32security.GROUP_SECURITY_INFORMATION)
-    sid = sd.GetSecurityDescriptorGroup()
-    print("  ", win32security.LookupAccountSid(None, sid))
-except pywintypes.error as exc:
-    if exc.winerror != winerror.ERROR_NONE_MAPPED:
-        raise
-    print("No group information is available")
-
-# get ACEs
-sd = win32security.GetFileSecurity(name, win32security.DACL_SECURITY_INFORMATION)
-dacl = sd.GetSecurityDescriptorDacl()
-if dacl is None:
-    print("No Discretionary ACL")
-else:
-    for ace_no in range(0, dacl.GetAceCount()):
-        ace = dacl.GetAce(ace_no)
-        print("ACE", ace_no)
-
-        print("  -Type")
-        for i in (
-            "ACCESS_ALLOWED_ACE_TYPE",
-            "ACCESS_DENIED_ACE_TYPE",
-            "SYSTEM_AUDIT_ACE_TYPE",
-            "SYSTEM_ALARM_ACE_TYPE",
-        ):
-            if getattr(ntsecuritycon, i) == ace[0][0]:
-                print("    ", i)
-
-        print("  -Flags", hex(ace[0][1]))
-        for i in (
-            "OBJECT_INHERIT_ACE",
-            "CONTAINER_INHERIT_ACE",
-            "NO_PROPAGATE_INHERIT_ACE",
-            "INHERIT_ONLY_ACE",
-            "SUCCESSFUL_ACCESS_ACE_FLAG",
-            "FAILED_ACCESS_ACE_FLAG",
-        ):
-            if getattr(ntsecuritycon, i) & ace[0][1] == getattr(ntsecuritycon, i):
-                print("    ", i)
-
-        print("  -mask", hex(ace[1]))
-
-        # files and directories do permissions differently
-        permissions_file = (
-            "DELETE",
-            "READ_CONTROL",
-            "WRITE_DAC",
-            "WRITE_OWNER",
-            "SYNCHRONIZE",
-            "FILE_GENERIC_READ",
-            "FILE_GENERIC_WRITE",
-            "FILE_GENERIC_EXECUTE",
-            "FILE_DELETE_CHILD",
-        )
-        permissions_dir = (
-            "DELETE",
-            "READ_CONTROL",
-            "WRITE_DAC",
-            "WRITE_OWNER",
-            "SYNCHRONIZE",
-            "FILE_ADD_SUBDIRECTORY",
-            "FILE_ADD_FILE",
-            "FILE_DELETE_CHILD",
-            "FILE_LIST_DIRECTORY",
-            "FILE_TRAVERSE",
-            "FILE_READ_ATTRIBUTES",
-            "FILE_WRITE_ATTRIBUTES",
-            "FILE_READ_EA",
-            "FILE_WRITE_EA",
-        )
-        permissions_dir_inherit = (
-            "DELETE",
-            "READ_CONTROL",
-            "WRITE_DAC",
-            "WRITE_OWNER",
-            "SYNCHRONIZE",
-            "GENERIC_READ",
-            "GENERIC_WRITE",
-            "GENERIC_EXECUTE",
-            "GENERIC_ALL",
-        )
-        if os.path.isfile(name):
-            permissions = permissions_file
-        else:
-            permissions = permissions_dir
-            # directories also contain an ACE that is inherited by children (files) within them
-            if (
-                ace[0][1] & ntsecuritycon.OBJECT_INHERIT_ACE
-                == ntsecuritycon.OBJECT_INHERIT_ACE
-                and ace[0][1] & ntsecuritycon.INHERIT_ONLY_ACE
-                == ntsecuritycon.INHERIT_ONLY_ACE
-            ):
-                permissions = permissions_dir_inherit
-
-        calc_mask = 0  # calculate the mask so we can see if we are printing all of the permissions
-        for i in permissions:
-            if getattr(ntsecuritycon, i) & ace[1] == getattr(ntsecuritycon, i):
-                calc_mask |= getattr(ntsecuritycon, i)
-                print("    ", i)
-        print("  ", "Calculated Check Mask=", hex(calc_mask))
-        print("  -SID\n    ", win32security.LookupAccountSid(None, ace[2]))

py2docfx/venv/venv1/Lib/site-packages/win32/Demos/GetSaveFileName.py

@@ -1,43 +0,0 @@
-import os
-
-import win32con
-import win32gui
-
-filter = "Python Scripts\0*.py;*.pyw;*.pys\0Text files\0*.txt\0"
-customfilter = "Other file types\0*.*\0"
-
-fname, customfilter, flags = win32gui.GetSaveFileNameW(
-    InitialDir=os.environ["temp"],
-    Flags=win32con.OFN_ALLOWMULTISELECT | win32con.OFN_EXPLORER,
-    File="somefilename",
-    DefExt="py",
-    Title="GetSaveFileNameW",
-    Filter=filter,
-    CustomFilter=customfilter,
-    FilterIndex=1,
-)
-
-print(f"save file names: {fname!r}")
-print(f"filter used: {customfilter!r}")
-print(f"Flags: {flags}")
-for k, v in win32con.__dict__.items():
-    if k.startswith("OFN_") and flags & v:
-        print("\t" + k)
-
-fname, customfilter, flags = win32gui.GetOpenFileNameW(
-    InitialDir=os.environ["temp"],
-    Flags=win32con.OFN_ALLOWMULTISELECT | win32con.OFN_EXPLORER,
-    File="somefilename",
-    DefExt="py",
-    Title="GetOpenFileNameW",
-    Filter=filter,
-    CustomFilter=customfilter,
-    FilterIndex=0,
-)
-
-print(f"open file names: {fname!r}")
-print(f"filter used: {customfilter!r}")
-print(f"Flags: {flags}")
-for k, v in win32con.__dict__.items():
-    if k.startswith("OFN_") and flags & v:
-        print("\t" + k)