class documentation

A representation of a URL.

Class Method fromBytes Make a URLPath from a bytes.
Class Method fromRequest Make a URLPath from a twisted.web.http.Request.
Class Method fromString Make a URLPath from a str or unicode.
Method __init__ Undocumented
Method __repr__ The repr of a URLPath is an eval-able expression which will construct a similar URLPath.
Method __str__ The str of a URLPath is its URL text.
Method child Get the child of this URLPath.
Method click Return a path which is the URL where a browser would presumably take you if you clicked on a link with an HREF as given.
Method here Get the current directory of this URLPath.
Method parent Get the parent directory of this URLPath.
Method pathList Split this URL's path into its components.
Method sibling Get the sibling of the current URLPath. A sibling is a file which is in the same directory as the current file.
Instance Variable fragment The page fragment (the portion after # in the URL).
Instance Variable netloc The network location ("host").
Instance Variable path The path on the network location.
Instance Variable query The query argument (the portion after ? in the URL).
Instance Variable scheme The scheme of the URL (e.g. 'http').
Class Method _fromURL Reconstruct all the public instance variables of this URLPath from its underlying _URL.
Method _mod Return a modified copy of self using newURL, keeping the query string if keepQuery is True.
Method _reconstitute Reconstitute this URLPath from all its given attributes.
Instance Variable _fragment Undocumented
Instance Variable _netloc Undocumented
Instance Variable _path Undocumented
Instance Variable _query Undocumented
Instance Variable _scheme Undocumented
Instance Variable _url Undocumented
@classmethod
def fromBytes(klass, url): (source)

Make a URLPath from a bytes.

Parameters
klassUndocumented
url:bytesA bytes representation of a URL.
Returns
URLPatha new URLPath derived from the given bytes.
Present Since
15.4
@classmethod
def fromRequest(klass, request): (source)

Make a URLPath from a twisted.web.http.Request.

Parameters
klassUndocumented
requestA twisted.web.http.Request to make the URLPath from.
Returns
URLPatha new URLPath derived from the given request.
@classmethod
def fromString(klass, url): (source)

Make a URLPath from a str or unicode.

Parameters
klassUndocumented
url:str or unicode.A str representation of a URL.
Returns
URLPatha new URLPath derived from the given string.
def __init__(self, scheme=b'', netloc=b'localhost', path=b'', query=b'', fragment=b''): (source)

Undocumented

def __repr__(self) -> str: (source)

The repr of a URLPath is an eval-able expression which will construct a similar URLPath.

def __str__(self) -> str: (source)

The str of a URLPath is its URL text.

def child(self, path, keepQuery=False): (source)

Get the child of this URLPath.

Parameters
path:bytesThe path of the child.
keepQuery:boolWhether to keep the query parameters on the returned URLPath.
Returns
a new URLPath
def click(self, st): (source)

Return a path which is the URL where a browser would presumably take you if you clicked on a link with an HREF as given.

Parameters
st:bytesA relative URL, to be interpreted relative to self as the base URL.
Returns
a new URLPath
def here(self, keepQuery=False): (source)

Get the current directory of this URLPath.

Parameters
keepQuery:boolWhether to keep the query parameters on the returned URLPath.
Returns
a new URLPath
def parent(self, keepQuery=False): (source)

Get the parent directory of this URLPath.

Parameters
keepQuery:boolWhether to keep the query parameters on the returned URLPath.
Returns
a new URLPath
def pathList(self, unquote=False, copy=True): (source)

Split this URL's path into its components.

Parameters
unquotewhether to remove %-encoding from the returned strings.
copy(ignored, do not use)
Returns
list of bytesThe components of self.path
def sibling(self, path, keepQuery=False): (source)

Get the sibling of the current URLPath. A sibling is a file which is in the same directory as the current file.

Parameters
path:bytesThe path of the sibling.
keepQuery:boolWhether to keep the query parameters on the returned URLPath.
Returns
a new URLPath

The page fragment (the portion after # in the URL).

The network location ("host").

The path on the network location.

The query argument (the portion after ? in the URL).

The scheme of the URL (e.g. 'http').

@classmethod
def _fromURL(cls, urlInstance): (source)

Reconstruct all the public instance variables of this URLPath from its underlying _URL.

Parameters
urlInstance:_URLthe object to base this URLPath on.
Returns
a new URLPath
def _mod(self, newURL, keepQuery): (source)

Return a modified copy of self using newURL, keeping the query string if keepQuery is True.

Parameters
newURL:URLa URL to derive a new URLPath from
keepQuery:boolif True, preserve the query parameters from self on the new URLPath; if False, give the new URLPath no query parameters.
Returns
a new URLPath
def _reconstitute(self): (source)

Reconstitute this URLPath from all its given attributes.

_fragment = (source)

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented