نمایش راهنمای یک کتابخانه (library - module)، شامل اطلاعات مفیدی مثل توابع تعریف شده در آن و ... ، با تابع help ، در پایتون (Python)

معمولا کتابخانه های (library - module) مختلف دارای یک راهنمای (help) داخلی (نوشته شده در خود آنها) هستند که شامل اطلاعات مفیدی در مورد کتابخانه و توابع تعریف شده در آن و ... می باشد.

برای نمایش راهنمای یک کتابخانه (library - module)، باید تابع help در پایتون (Python) را به کار ببریم.

به مثال زیر توجه کنید :

مثال

برای نمایش راهنمای کتابخانه math ، کدهای پایتون زیر را اجرا می نماییم :

نتیجه :

Help on built-in module math:

NAME
    math

DESCRIPTION
    This module is always available.  It provides access to the
    mathematical functions defined by the C standard.

FUNCTIONS
    acos(...)
        acos(x)
       
        Return the arc cosine (measured in radians) of x.
   
    acosh(...)
        acosh(x)
       
        Return the inverse hyperbolic cosine of x.
   
    asin(...)
        asin(x)
       
        Return the arc sine (measured in radians) of x.
   
    asinh(...)
        asinh(x)
       
        Return the inverse hyperbolic sine of x.
   
    atan(...)
        atan(x)
       
        Return the arc tangent (measured in radians) of x.
   
    atan2(...)
        atan2(y, x)
       
        Return the arc tangent (measured in radians) of y/x.
        Unlike atan(y/x), the signs of both x and y are considered.
   
    atanh(...)
        atanh(x)
       
        Return the inverse hyperbolic tangent of x.
   
    ceil(...)
        ceil(x)
       
        Return the ceiling of x as an int.
        This is the smallest integral value >= x.
   
    copysign(...)
        copysign(x, y)
       
        Return a float with the magnitude (absolute value) of x but the sign
        of y. On platforms that support signed zeros, copysign(1.0, -0.0)
        returns -1.0.
   
    cos(...)
        cos(x)
       
        Return the cosine of x (measured in radians).
   
    cosh(...)
        cosh(x)
       
        Return the hyperbolic cosine of x.
   
    degrees(...)
        degrees(x)
       
        Convert angle x from radians to degrees.
   
    erf(...)
        erf(x)
       
        Error function at x.
   
    erfc(...)
        erfc(x)
       
        Complementary error function at x.
   
    exp(...)
        exp(x)
       
        Return e raised to the power of x.
   
    expm1(...)
        expm1(x)
       
        Return exp(x)-1.
        This function avoids the loss of precision involved in the direct evaluation of exp(x)-1 for small x.
   
    fabs(...)
        fabs(x)
       
        Return the absolute value of the float x.
   
    factorial(...)
        factorial(x) -> Integral
       
        Find x!. Raise a ValueError if x is negative or non-integral.
   
    floor(...)
        floor(x)
       
        Return the floor of x as an int.
        This is the largest integral value <= x.
   
    fmod(...)
        fmod(x, y)
       
        Return fmod(x, y), according to platform C.  x % y may differ.
   
    frexp(...)
        frexp(x)
       
        Return the mantissa and exponent of x, as pair (m, e).
        m is a float and e is an int, such that x = m * 2.**e.
        If x is 0, m and e are both 0.  Else 0.5 <= abs(m) < 1.0.
   
    fsum(...)
        fsum(iterable)
       
        Return an accurate floating point sum of values in the iterable.
        Assumes IEEE-754 floating point arithmetic.
   
    gamma(...)
        gamma(x)
       
        Gamma function at x.
   
    gcd(...)
        gcd(x, y) -> int
        greatest common divisor of x and y
   
    hypot(...)
        hypot(x, y)
       
        Return the Euclidean distance, sqrt(x*x + y*y).
   
    isclose(...)
        is_close(a, b, *, rel_tol=1e-09, abs_tol=0.0) -> bool
       
        Determine whether two floating point numbers are close in value.
       
           rel_tol
               maximum difference for being considered "close", relative to the
               magnitude of the input values
            abs_tol
               maximum difference for being considered "close", regardless of the
               magnitude of the input values
       
        Return True if a is close in value to b, and False otherwise.
       
        For the values to be considered close, the difference between them
        must be smaller than at least one of the tolerances.
       
        -inf, inf and NaN behave similarly to the IEEE 754 Standard.  That
        is, NaN is not close to anything, even itself.  inf and -inf are
        only close to themselves.
   
    isfinite(...)
        isfinite(x) -> bool
       
        Return True if x is neither an infinity nor a NaN, and False otherwise.
   
    isinf(...)
        isinf(x) -> bool
       
        Return True if x is a positive or negative infinity, and False otherwise.
   
    isnan(...)
        isnan(x) -> bool
       
        Return True if x is a NaN (not a number), and False otherwise.
   
    ldexp(...)
        ldexp(x, i)
       
        Return x * (2**i).
   
    lgamma(...)
        lgamma(x)
       
        Natural logarithm of absolute value of Gamma function at x.
   
    log(...)
        log(x[, base])
       
        Return the logarithm of x to the given base.
        If the base not specified, returns the natural logarithm (base e) of x.
   
    log10(...)
        log10(x)
       
        Return the base 10 logarithm of x.
   
    log1p(...)
        log1p(x)
       
        Return the natural logarithm of 1+x (base e).
        The result is computed in a way which is accurate for x near zero.
   
    log2(...)
        log2(x)
       
        Return the base 2 logarithm of x.
   
    modf(...)
        modf(x)
       
        Return the fractional and integer parts of x.  Both results carry the sign
        of x and are floats.
   
    pow(...)
        pow(x, y)
       
        Return x**y (x to the power of y).
   
    radians(...)
        radians(x)
       
        Convert angle x from degrees to radians.
   
    sin(...)
        sin(x)
       
        Return the sine of x (measured in radians).
   
    sinh(...)
        sinh(x)
       
        Return the hyperbolic sine of x.
   
    sqrt(...)
        sqrt(x)
       
        Return the square root of x.
   
    tan(...)
        tan(x)
       
        Return the tangent of x (measured in radians).
   
    tanh(...)
        tanh(x)
       
        Return the hyperbolic tangent of x.
   
    trunc(...)
        trunc(x:Real) -> Integral
       
        Truncates x to the nearest Integral toward 0. Uses the __trunc__ magic method.

DATA
    e = 2.718281828459045
    inf = inf
    nan = nan
    pi = 3.141592653589793

FILE
    (built-in)

قسمت FILE ، مسیر فایل پایتون (با پسوند py) مربوط به کتابخانه را نمایش خواهد داد، اما در مثال بالا، برای آن، عبارت (built-in) نوشته شده که یعنی داخلی است و یک فایل پایتون جداگانه برای آن وجود ندارد.

مثال

نتیجه :

Help on module pydoc:

NAME
    pydoc - Generate Python documentation in HTML or text for interactive use.

DESCRIPTION
    At the Python interactive prompt, calling help(thing) on a Python object
    documents the object, and calling help() starts up an interactive
    help session.
   
    Or, at the shell command line outside of Python:
   
    Run "pydoc <name>" to show documentation on something.  <name> may be
    the name of a function, module, package, or a dotted reference to a
    class or function within a module or module in a package.  If the
    argument contains a path segment delimiter (e.g. slash on Unix,
    backslash on Windows) it is treated as the path to a Python source file.
   
    Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines
    of all available modules.
   
    Run "pydoc -p <port>" to start an HTTP server on the given port on the
    local machine.  Port number 0 can be used to get an arbitrary unused port.
   
    Run "pydoc -b" to start an HTTP server on an arbitrary unused port and
    open a Web browser to interactively browse documentation.  The -p option
    can be used with the -b option to explicitly specify the server port.
   
    Run "pydoc -w <name>" to write out the HTML documentation for a module
    to a file named "<name>.html".
   
    Module docs for core modules are assumed to be in
   
        http://docs.python.org/X.Y/library/
   
    This can be overridden by setting the PYTHONDOCS environment variable
    to a different URL or to a local directory containing the Library
    Reference Manual pages.

DATA
    __all__ = ['help']
    help = <pydoc.Helper instance>

DATE
    26 February 2001

AUTHOR
    Ka-Ping Yee <ping@lfw.org>

CREDITS
    Guido van Rossum, for an excellent programming language.
    Tommy Burnette, the original creator of manpy.
    Paul Prescod, for all his work on onlinehelp.
    Richard Chamberlain, for the first implementation of textdoc.

FILE
    c:\users\utabrayan\appdata\local\programs\python\python35-32\lib\pydoc.py

مشاهده می کنید که در قسمت FILE ، مسیر فایل پایتون (با پسوند py) مربوط به کتابخانه ذکر شده است :

دسته بندی کار با کتابخانه ها (Libraries - Modules)، در پایتون (Python)

نویسنده علیرضا گلمکانی

شماره کلید 4740

گزینه ها