如何访问python包中顶级文件中的代码

Question

I have a Python 2.7 package laid out like this:

hdl/
    __init__.py
    run_job.py
    other_stuff/
        __init__.py
        other_files/
setup.py
scripts/
    client.py

run_job.py contains:

def run_job():
    pass

There is no class. Actually, there are no classes anywhere in this codebase; I inherited it.

How do I execute the run_job() function from clients of this package?

(Right now, the run_job() function lives in __init__.py , which I don't like at all.)

I put these in __init__.py :

import hdl.run_job

import run_job

Either way, I get No module named run_job . If I leave off the import entirely, the client code says either 'module' object has no attribute 'run_job' or name 'run_job' is not defined , depending on which of these I do:

import hdl
hdl.run_job

import hdl
run_job

My setup.py :

from setuptools import setup
from setuptools import find_packages
from os import walk, path

install_requires = [
    "ecdsa==0.11",
    "importlib==1.0.3",
    "paramiko==1.13.0",
    "pyasn1==0.1.7",
    "pycrypto==2.6.1",
    "wsgiref==0.1.2",
]

script_base = "scripts"
my_path = path.dirname(path.abspath(__file__))
walk_path = path.join(my_path, script_base)
for(_, _, filenames) in walk(walk_path):
    scripts = [("%s/%s"  % (script_base, f)) for f in filenames]
    break

setup(
    name="hdl",
    version="dev",
    description="HDL",
    url="http://example.com",
    long_description="HDLA",
    author="heh",
    author_email=".com",
    maintainer="foo",
    maintainer_email=".com",
    license="Proprietary",
    packages=find_packages(exclude=("tests",)),
    test_suite="nose.collector",
    include_package_data=True,
    package_data = {'': [ '*.csv', '*.hql', '*.pig', '*.sh', '*.sql' ]},
    install_requires=install_requires,
    zip_safe=False,
    classifiers=[
        "Development Status :: 2 - Alpha",
        "Environment :: Command Line",
        "Framework :: None",
        "Intended Audience :: Developers",
        "Intended Audience :: System Administrators",
        "License :: Other/Proprietary License",
        "Natural Language :: English",
        "Operating System :: MacOS :: MacOS X",
        "Operating System :: POSIX :: Linux",
        "Programming Language :: Python :: 2.7",
        "Topic :: Software Development",
        "Topic :: ETL"
    ],
    scripts=scripts,
)

If I stick the run_job function in __init__.py it works fine: import hdl hdl.run_job()

Answer 1

Put the following in __init__.py :

__all__ = ["run_job"]

In your client:

from hdl import run_job
run_job.run_job()

in your setup.py "scripts" variable is not defined, so I had to remove the following string:

scripts=scripts,

After that I ran "sudo python setup.py install" and tested it with the client:

$ python
Python 2.7.6 (default, Mar 22 2014, 17:40:27) 
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from hdl import run_job
>>> run_job.run_job()
>>> 

Everything works. Try yet another thing:

pydoc hdl

Check if the path provided in the generated doc refers to the right location.

Help on package hdl:

NAME
    hdl

FILE
    <path-to-hdl>/hdl/__init__.py

PACKAGE CONTENTS
    run_job

So, I have exactly the same layout and setup.py file as yours. Below is the content of files and it works on my comp. Try to carefully compare with what you have and make sure that "setup.py install" doesn't have any errors. If pydoc doesn't show anything, hdl was not installed.

==========
run_job.py
=========== 
def run_job():
    pass

============ client.py ===========

from hdl import run_job
run_job.run_job()

============ setup.py ===========

exactly as yours

Answer 2

Your client code needs to do from hdl import run_job and then do run_job.run_job() , or (probably more readable) from hdl.run_job import run_job .

If you want to provide "top level" access to run_job (that is, not require users to import the run_job module to get the run_job function), then in your top-level __init__.py do from .run_job import run_job . Then clients can do import hdl and later use hdl.run_job .

Answer 3

The file wasn't named run_job.py it was named something else. Sigh . Fixing the name causes everything to work.

The other answers are correct; leave the __init__.py empty and in client.py do this:

from hdl import run_job
run_job.run_job()

or

from hdl.run_job import run_job
run_job()

or put this in __init__.py :

from .run_job import run_job

and this in client.py :

import hdl
hdl.run_job() # won't work