Method getdocloc

Lib/pydoc.py:564–598

Return the location of module docs or None

(self, object, basedir=sysconfig.get_path('stdlib'))

    docmodule = docclass = docroutine = docother = docproperty = docdata = fail

    def getdocloc(self, object, basedir=sysconfig.get_path('stdlib')):
        """Return the location of module docs or None"""

        try:
            file = inspect.getabsfile(object)
        except TypeError:
            file = '(built-in)'

        docloc = os.environ.get("PYTHONDOCS", self.PYTHONDOCS)

        basedir = os.path.normcase(basedir)
        if (isinstance(object, type(os)) and
            (object.__name__ in ('errno', 'exceptions', 'gc',
                                 'marshal', 'posix', 'signal', 'sys',
                                 '_thread', 'zipimport') or
             (file.startswith(basedir) and
              not file.startswith(os.path.join(basedir, 'site-packages')))) and
            object.__name__ not in ('xml.etree', 'test.test_pydoc.pydoc_mod')):

            try:
                from pydoc_data import module_docs
            except ImportError:
                module_docs = None

            if module_docs and object.__name__ in module_docs.module_docs:
                doc_name = module_docs.module_docs[object.__name__]
                if docloc.startswith(("http://", "https://")):
                    docloc = "{}/{}".format(docloc.rstrip("/"), doc_name)
                else:
                    docloc = os.path.join(docloc, doc_name)
            else:
                docloc = None
        else:
            docloc = None
        return docloc

# -------------------------------------------- HTML documentation generator