如何编写Python模块/包?

我一直在为工作中的简单任务编写Python脚本，从未真正费心将它们打包供他人使用。现在我被指派为REST API制作Python包装器。我完全不知道如何开始，我需要帮助。

我有什么:

(只是想尽可能具体)我已经准备好了virtualenv，它也是在github上, python的.gitignore文件也在那里，另外，请求图书馆用于与REST API交互。就是这样。

这是当前目录树

.
├── bin
│   └── /the usual stuff/
├── include
│   └── /the usual stuff/
├── lib
│   └── python2.7
│       └── /the usual stuff/
├── local
│   └── /the usual stuff/
└── README.md


27 directories, 280 files

我甚至不知道该把。py文件放在哪里，如果我要创建的话。

我想做的是:

使用"pip install…"使python模块可安装

如果可能的话，我想要一个关于编写Python模块的通用步骤。

423021 次浏览
小开
最佳答案

模块是一个包含Python定义和语句的文件。文件名是模块名，后缀为.py

创建hello.py，然后将以下函数作为其内容:

def helloworld():
print "hello"

然后你可以导入hello:

>>> import hello
>>> hello.helloworld()
'hello'
>>>

要将许多.py文件分组，将它们放在一个文件夹中。任何带有__init__.py的文件夹在python中都被认为是模块，你可以称它们为包

|-HelloModule
|_ __init__.py
|_ hellomodule.py

您可以按照通常的方式使用模块上的import语句。

更多信息，参见6.4. 包。

小开

Python 3 - 2015年11月18日更新

我认为公认的答案是有用的，但我希望根据自己的经验进一步阐述几点，以造福他人。

模块:模块是一个包含Python定义和语句的文件。文件名是附加了.py后缀的模块名。

模块的例子:假设当前目录中有一个python脚本，这里我称它为mymodule.py

mymodule.py文件包含以下代码:

def myfunc():
print("Hello!")

如果我们从当前目录运行python3解释器，我们可以以以下不同的方式导入并运行函数myfunc(通常只选择以下方式之一):

>>> import mymodule
>>> mymodule.myfunc()
Hello!
>>> from mymodule import myfunc
>>> myfunc()
Hello!
>>> from mymodule import *
>>> myfunc()
Hello!

这很简单。

现在假设您需要将这个模块放到它自己的专用文件夹中，以提供一个模块名称空间，而不是仅仅从当前工作目录中临时运行它。这是值得解释包概念的地方。

包:包是通过使用“虚线模块名”来构造Python模块名称空间的一种方式。例如，模块名A.B在名为a的包中指定了名为B的子模块。就像使用模块可以使不同模块的作者不必担心彼此的全局变量名一样，使用虚线模块名可以使NumPy或Python成像库等多模块包的作者不必担心彼此的模块名。

包的例子:让我们现在假设我们有以下文件夹和文件。这里，mymodule.py与之前相同，而__init__ . py是一个空文件:

.
└── mypackage
├── __init__.py
└── mymodule.py

需要__init__.py文件才能使Python将这些目录视为包含包的目录。欲了解更多信息，请参阅稍后提供的Modules文档链接。

我们当前的工作目录比普通文件夹mypackage高一级

$ ls
mypackage

如果我们现在运行python3解释器，我们可以通过以下不同的方式导入并运行包含所需函数myfunc的模块mymodule.py(你通常只会选择以下方式之一):

>>> import mypackage
>>> from mypackage import mymodule
>>> mymodule.myfunc()
Hello!
>>> import mypackage.mymodule
>>> mypackage.mymodule.myfunc()
Hello!
>>> from mypackage import mymodule
>>> mymodule.myfunc()
Hello!
>>> from mypackage.mymodule import myfunc
>>> myfunc()
Hello!
>>> from mypackage.mymodule import *
>>> myfunc()
Hello!

假设Python 3，在:模块有很好的文档

关于包和模块的命名约定，一般指导原则在PEP-0008中给出-请参阅包和模块名称

模块应该有简短的、全小写的名称。如果可以提高可读性，可以在模块名中使用下划线。Python包还应该有简短的、全小写的名称，尽管不鼓励使用下划线。

小开

定义了所选命令后，只需将保存的文件拖放到python程序文件中的Lib文件夹中。

>>> import mymodule
>>> mymodule.myfunc()
小开

创建一个名为"hello。py"的文件

如果你使用的是Python 2.x

def func():
print "Hello"

如果你使用的是Python 3.x

def func():
print("Hello")

运行文件。然后，你可以尝试以下方法:

>>> import hello
>>> hello.func()
Hello

如果你想硬一点，可以用下面的方法:

如果你使用的是Python 2.x

def say(text):
print text

如果你使用的是Python 3.x

def say(text):
print(text)

看到define旁边括号里的那个了吗?这很重要。它是可以在define中使用的。

文本-当你想让程序说出你想要的东西时，你可以使用它。根据它的名字，它是文本。我希望你知道文字是什么意思。它的意思是“单词”或“句子”。

运行文件。然后，如果您正在使用Python 3.x，您可以尝试以下操作:

>>> import hello
>>> hello.say("hi")
hi
>>> from hello import say
>>> say("test")
test

对于Python 2。x -我猜Python 3也是一样的?不知道。如果我在Python 2上犯了错误，请纠正我。x(我知道Python 2，但我用Python 3)

小开

因为还没有人讨论OP的这个问题:

我想做的是:

使用"pip install…"使python模块可安装

下面是一个绝对最小的例子，展示了使用setuptools和twine准备和上传包到PyPI的基本步骤。

这绝不是的替代品，至少阅读教程，它比这个非常基本的示例所涵盖的内容多得多。

创建包本身已经在这里的其他答案中涵盖了，所以让我们假设我们已经涵盖了这一步，我们的项目结构是这样的:

.
└── hellostackoverflow/
├── __init__.py
└── hellostackoverflow.py

为了使用setuptools进行打包，我们需要添加一个文件setup.py，它会进入项目的根文件夹:

.
├── setup.py
└── hellostackoverflow/
├── __init__.py
└── hellostackoverflow.py

至少，我们为我们的包指定元数据，我们的setup.py看起来像这样:

from setuptools import setup


setup(
name='hellostackoverflow',
version='0.0.1',
description='a pip-installable package example',
license='MIT',
packages=['hellostackoverflow'],
author='Benjamin Gerfelder',
author_email='benjamin.gerfelder@gmail.com',
keywords=['example'],
url='https://github.com/bgse/hellostackoverflow'
)

因为我们已经设置了license='MIT'，所以我们在项目中包含了一个副本LICENCE.txt，并在reStructuredText中包含了一个自述文件README.rst:

.
├── LICENCE.txt
├── README.rst
├── setup.py
└── hellostackoverflow/
├── __init__.py
└── hellostackoverflow.py

此时，我们已经准备好开始使用setuptools进行打包，如果我们还没有安装它，我们可以使用pip来安装它:

pip install setuptools

为了做到这一点并创建source distribution，在我们的项目根文件夹中，我们从命令行调用我们的setup.py，指定我们想要sdist:

python setup.py sdist

这将创建我们的分发包和egg-info，并产生如下的文件夹结构，包位于dist中:

.
├── dist/
├── hellostackoverflow.egg-info/
├── LICENCE.txt
├── README.rst
├── setup.py
└── hellostackoverflow/
├── __init__.py
└── hellostackoverflow.py

在这一点上，我们有一个可以使用pip安装的包，所以从我们的项目根(假设你有这个例子中所有的命名):

pip install ./dist/hellostackoverflow-0.0.1.tar.gz

如果一切顺利，我们现在可以打开一个Python解释器，我建议在项目目录之外的某个地方，以避免任何混乱，并尝试使用我们闪亮的新包:

Python 3.5.2 (default, Sep 14 2017, 22:51:06)
[GCC 5.4.0 20160609] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from hellostackoverflow import hellostackoverflow
>>> hellostackoverflow.greeting()
'Hello Stack Overflow!'

现在我们已经确认了包的安装和工作，我们可以将其上传到PyPI。

因为我们不想用我们的实验污染活动存储库，所以我们为测试库创建了一个帐户，并为上传过程安装twine:

pip install twine

现在我们差不多完成了，创建了我们的帐户后，我们只需告诉twine上传我们的包，它将询问我们的凭据并将我们的包上传到指定的存储库:

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

现在，我们可以登录到PyPI测试库的帐户，并对新上传的包惊叹一段时间，然后使用pip获取它:

pip install --index-url https://test.pypi.org/simple/ hellostackoverflow

正如我们所看到的，基本的过程并不是很复杂。正如我之前说过的，这里有更多的内容，所以继续和阅读教程进行更深入的解释。

小开

模块是一个包含Python定义和语句的文件。文件名是带有.py后缀的模块名

创建一个名为hello.py的文件，其内容为以下函数:

def helloworld():
print "hello"

然后你就可以

import hello
hello.helloworld()

要对许多.py文件进行分组，请将它们放在一个文件夹中。任何带有初始化.py的文件夹在python中都被认为是模块，你可以称它们为包。

< p > | -HelloModule | _ 初始化.py | _ hellomodule.py < / p >

提交答案