保姆级教程带你开发优质的Python库之中篇【命令行发行】_python 命令行开发指导

2401_84253850

于 2024-05-02 09:00:22 发布

阅读量404

点赞数 4

分类专栏：程序员文章标签： python 开发语言

本文链接：https://blog.csdn.net/2401_84253850/article/details/138387267

版权

程序员专栏收录该内容

203 篇文章 0 订阅

订阅专栏

文章介绍了Python的setup.py文件中entry_points的使用，如何通过entry_points在pip安装时自动生成命令行工具pypiseed和pyseed，以及这两个工具的基本功能和命令行参数解析。

摘要由CSDN通过智能技术生成

先看一下代码，大家重点观察一个熟悉：entry_points 。

# -\*- coding: utf-8 -\*-
# @CSDN/Juejin/Wechat: 雷学委
# @XueWeiTag: OpenSource
# @File : setup.py
# @Project : pypi\_seed


from distutils.core import setup
from setuptools import find_packages

setup(name='pypi\_seed',  # 包名
      version='1.0.3',  # 版本号
      keywords=("pypi\_seed", "seed", "generator", "levin", "leixuewei"),
      description='A small tool to demo on upload package to pypi and utility scripts to generate a pypi seed',
      long_description="""A small tool to demo on upload package to pypi and utility scripts to generate a pypi seed!
Powered by py4ever team!""",
      author='levin',
      author_email='790839397@qq.com', #项目联系人
      url='https://github.com/py4ever/pypi\_seed',
      #学委删简了一些，非本文重点的信息
      entry_points={
          'console\_scripts': [
              'pypiseed = pypi\_seed.main:main',
              'pyseed = pypi\_seed.main:main'
          ]
      },
      classifiers=[
          'Intended Audience :: Developers' # 学委删简了一些支持多版本的，需要的去github或者gitee借鉴pypi\_seed的setup.py
      ],
      )

解释一下setup.py

简单理解，这个setup.py 就相当于一个开源模块的地图。

它包括了作者信息，项目说明，版本，项目链接，更重要的，安装后命令行的程序入口就放在“entry_points"。

设置了entry_points, 我们使用pip工具安装这个模块的时候，它会自动帮我们创建相应的文件。

比如上面的entry_points是两个命令工具：

pypiseed 为命令行工具，对等与调用pypi_seed.main:main
pyseed 为命令行工具，对等与调用pypi_seed.main:main

补充说明setup.py其他参数解释

重点是作者，项目名称，联系信息，下面整理解释：

name ：项目名称，特别重要！其他开发者通过这个来搜索你的库
author : 作者
keywords : 项目关键字
description : 项目说明
author_email : 作者邮箱信息
url : 项目主页

这些比较直白，根据开源工具的定位来编写完善。

项目说明如果写不下，就放置在long description字段。万一用户在用的时候有啥反馈，还能够联系到邮箱，或者通过项目主页继续互动，这样能够保持项目的不断完善，与时俱进！

第二步开发一个命令行处理的Python程序

生成了程序入口了，我们可以通过

pyseed  参数 #调用pypi\_seed了

好了，说完entry_points, 它调用到了pypi_seed.main:main。学委已经帮大家看了源码了。

pypiseed / pyseed里面调用了一个程序内的show_help 和args2dict 两个方法。

开源项目源码解析

这里是show_help方法，重点是输出打印一些使用信息，和项目简易说明。

def show\_help():
    print('usage:')
    print('-h, --help: print help message.')
    print('-p, --project: your desired project name')
    print('-P, --path: where to save the sample project after code-generation')
    print('-a, --author: the author information')
    print("===========================================")
    show_sample_run()
    show_about()

这里就是本文的核心了，解析用户的输入。

为了解析方便，学委仅摘取了核心代码段，我们看一下。

import sys
import getopt

def args2dict():
    argv = sys.argv[1:]
    if '-h' in argv or '--help' in argv:
        show_help()
        exit(0)
    try:
        opts, args = getopt.getopt(argv, "p:P:a",
                                   ["path=",
                                    "author=",
                                    "project="])
    except Exception as e:
        raise ValueError("Looks like missing value, please check usage by '-h'. Current error : %s " % str(e))
    project = author = path = None
    for opt, arg in opts:
        if opt in ['-p', '--project']:
            project = arg
        elif opt in ['-a', '--author']:
            author = arg
        elif opt in ['-P', '--path']:
            path = arg
    if project is None:
        print("please input project with '-p' or '--project', e.g. -p my\_project ")
        raise ValueError("Missing project")
    if author is None:
        print("please input author with '-a' or '--author', e.g. -a whoami ")
        raise ValueError("Missing author")
    if path is None:
        path = os.getcwd()
        print("path is not given, so will use default as current directory : %s" % path)
    return dict(project=project, author=author, path=path)