arelle.WebCache
#
See COPYRIGHT.md for copyright information.
For SEC EDGAR data access see: https://www.sec.gov/os/accessing-edgar-data
e.g., User-Agent: Sample Company Name AdminContact@
Module Contents#
Classes#
Functions#
Data#
API#
- arelle.WebCache.addServerWebCache#
None
- arelle.WebCache.DIRECTORY_INDEX_FILE#
‘!~DirectoryIndex~!’
- arelle.WebCache.INF#
None
- arelle.WebCache.RETRIEVAL_RETRY_COUNT#
5
- arelle.WebCache.HTTP_USER_AGENT#
None
- arelle.WebCache.proxyDirFmt(httpProxyTuple)#
- arelle.WebCache.proxyTuple(url)#
- arelle.WebCache.lastModifiedTime(headers)#
- class arelle.WebCache.WebCache(cntlr: arelle.Cntlr.Cntlr, httpProxyTuple: tuple[bool, str, str, str, str] | None)#
Initialization
- default_timeout#
None
- property timeout#
- property recheck#
- property logDownloads#
- saveUrlCheckTimes() None #
- property noCertificateCheck#
- property httpUserAgent#
- property httpsRedirect#
- resetProxies(httpProxyTuple)#
- normalizeUrl(url: Optional[str], base: Optional[str] = None) Any #
- encodeForFilename(pathpart)#
- urlToCacheFilepath(url: str) str #
- cacheFilepathToUrl(cacheFilepath)#
- getfilename(url: str | None, base: str | None = None, reload: bool = False, checkModifiedTime: bool = False, normalize: bool = False, filenameOnly: bool = False) str | None #
- internetRecheckFailedRecovery(filepath, url, err, timeNowStr)#
- reportProgress(blockCount, blockSize, totalSize)#
- clear()#
- getheaders(url)#
- geturl(url)#
- retrieve(url, filename=None, filestream=None, reporthook=None, data=None)#