annotate stubs/twisted/python/filepath.pyi @ 1863:0f0ff27e55a3

stubs, mostly autogen or empty Ignore-this: bc70818d2bc92bf022c65c3572b9775e
author Drew Perttula <drewp@bigasterisk.com>
date Sat, 25 May 2019 12:01:26 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1863
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
1 # Stubs for twisted.python.filepath (Python 3)
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
2 #
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
3 # NOTE: This dynamically typed stub was automatically generated by stubgen.
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
4
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
5 import base64
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
6 import os
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
7 from twisted.python.util import FancyEqMixin
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
8 from typing import Any, Optional
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
9 from zope.interface import Interface
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
10
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
11 islink: Any
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
12 randomBytes = os.urandom
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
13 armor = base64.urlsafe_b64encode
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
14
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
15 class IFilePath(Interface):
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
16 def child(self, name: Any) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
17 def open(self, mode: str = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
18 def changed(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
19 def getsize(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
20 def getModificationTime(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
21 def getStatusChangeTime(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
22 def getAccessTime(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
23 def exists(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
24 def isdir(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
25 def isfile(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
26 def children(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
27 def basename(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
28 def parent(self, ) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
29 def sibling(self, name: Any) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
30
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
31 class InsecurePath(Exception): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
32 class LinkError(Exception): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
33
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
34 class UnlistableError(OSError):
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
35 originalException: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
36 def __init__(self, originalException: Any) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
37
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
38 class _WindowsUnlistableError(UnlistableError, WindowsError): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
39
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
40 class AbstractFilePath:
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
41 def getContent(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
42 def parents(self) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
43 def children(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
44 def walk(self, descend: Optional[Any] = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
45 def sibling(self, path: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
46 def descendant(self, segments: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
47 def segmentsFrom(self, ancestor: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
48 def __hash__(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
49 def getmtime(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
50 def getatime(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
51 def getctime(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
52
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
53 class RWX(FancyEqMixin):
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
54 compareAttributes: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
55 read: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
56 write: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
57 execute: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
58 def __init__(self, readable: Any, writable: Any, executable: Any) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
59 def shorthand(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
60
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
61 class Permissions(FancyEqMixin):
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
62 compareAttributes: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
63 def __init__(self, statModeInt: Any) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
64 def shorthand(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
65
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
66 class _SpecialNoValue: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
67
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
68 class FilePath(AbstractFilePath):
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
69 path: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
70 alwaysCreate: Any = ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
71 def __init__(self, path: Any, alwaysCreate: bool = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
72 @property
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
73 def sep(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
74 def asBytesMode(self, encoding: Optional[Any] = ...): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
75 def asTextMode(self, encoding: Optional[Any] = ...): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
76 def child(self, path: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
77 def preauthChild(self, path: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
78 def childSearchPreauth(self, *paths: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
79 def siblingExtensionSearch(self, *exts: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
80 def realpath(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
81 def siblingExtension(self, ext: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
82 def linkTo(self, linkFilePath: Any) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
83 def open(self, mode: str = ...): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
84 def restat(self, reraise: bool = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
85 def changed(self) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
86 def chmod(self, mode: Any) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
87 def getsize(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
88 def getModificationTime(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
89 def getStatusChangeTime(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
90 def getAccessTime(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
91 def getInodeNumber(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
92 def getDevice(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
93 def getNumberOfHardLinks(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
94 def getUserID(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
95 def getGroupID(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
96 def getPermissions(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
97 def exists(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
98 def isdir(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
99 def isfile(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
100 def isBlockDevice(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
101 def isSocket(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
102 def islink(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
103 def isabs(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
104 def listdir(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
105 def splitext(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
106 def touch(self) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
107 def remove(self) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
108 def makedirs(self, ignoreExistingDirectory: bool = ...): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
109 def globChildren(self, pattern: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
110 def basename(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
111 def dirname(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
112 def parent(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
113 def setContent(self, content: Any, ext: bytes = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
114 def __cmp__(self, other: Any): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
115 def createDirectory(self) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
116 def requireCreate(self, val: int = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
117 def create(self): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
118 def temporarySibling(self, extension: bytes = ...): ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
119 def copyTo(self, destination: Any, followLinks: bool = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
120 def moveTo(self, destination: Any, followLinks: bool = ...) -> None: ...
0f0ff27e55a3 stubs, mostly autogen or empty
Drew Perttula <drewp@bigasterisk.com>
parents:
diff changeset
121 def statinfo(self, value: Any = ...): ...