Tập lệnh sau cài đặt với công cụ thiết lập Python

Có thể chỉ định tệp kịch bản Python sau cài đặt như một phần của tệp setuptools setup.py để người dùng có thể chạy lệnh:

python setup.py install

trên kho lưu trữ tệp dự án cục bộ, hoặc

pip install <name>

cho một dự án PyPI và tập lệnh sẽ được chạy khi hoàn thành cài đặt công cụ thiết lập tiêu chuẩn? Tôi đang tìm cách thực hiện các tác vụ sau cài đặt có thể được mã hóa trong một tệp kịch bản Python duy nhất (ví dụ: gửi thông báo sau cài đặt tùy chỉnh cho người dùng, kéo các tệp dữ liệu bổ sung từ một kho lưu trữ nguồn từ xa khác).

Tôi đã xem câu trả lời SO này từ vài năm trước đề cập đến chủ đề và có vẻ như sự đồng thuận tại thời điểm đó là bạn cần tạo một lệnh con cài đặt. Nếu trường hợp đó vẫn xảy ra, liệu ai đó có thể cung cấp ví dụ về cách thực hiện việc này để người dùng không cần nhập lệnh thứ hai để chạy tập lệnh không?

Lưu ý: Giải pháp bên dưới chỉ hoạt động khi cài đặt zip phân phối nguồn hoặc tarball hoặc cài đặt ở chế độ có thể chỉnh sửa từ cây nguồn. Nó sẽ không hoạt động khi cài đặt từ bánh xe nhị phân ( .whl)

Giải pháp này minh bạch hơn:

Bạn sẽ thực hiện một số bổ sung setup.pyvà không cần thêm tệp.

Ngoài ra, bạn cần phải xem xét hai cài đặt sau khác nhau; một cho chế độ phát triển / có thể chỉnh sửa và một cho chế độ cài đặt.

Thêm hai loại cổ phiếu này bao gồm các bạn sau khi cài đặt kịch bản để setup.py:

from setuptools import setup
from setuptools.command.develop import develop
from setuptools.command.install import install


class PostDevelopCommand(develop):
    """Post-installation for development mode."""
    def run(self):
        develop.run(self)
        # PUT YOUR POST-INSTALL SCRIPT HERE or CALL A FUNCTION

class PostInstallCommand(install):
    """Post-installation for installation mode."""
    def run(self):
        install.run(self)
        # PUT YOUR POST-INSTALL SCRIPT HERE or CALL A FUNCTION

và chèn cmdclassđối số vào setup()hàm trong setup.py:

setup(
    ...

    cmdclass={
        'develop': PostDevelopCommand,
        'install': PostInstallCommand,
    },

    ...
)

Bạn thậm chí có thể gọi các lệnh shell trong khi cài đặt, như trong ví dụ này chuẩn bị trước khi cài đặt:

from setuptools import setup
from setuptools.command.develop import develop
from setuptools.command.install import install
from subprocess import check_call


class PreDevelopCommand(develop):
    """Pre-installation for development mode."""
    def run(self):
        check_call("apt-get install this-package".split())
        develop.run(self)

class PreInstallCommand(install):
    """Pre-installation for installation mode."""
    def run(self):
        check_call("apt-get install this-package".split())
        install.run(self)


setup(
    ...

PS không có bất kỳ điểm nhập cài đặt trước nào có sẵn trên các công cụ thiết lập. Đọc cuộc thảo luận này nếu bạn đang tự hỏi tại sao không có.

Lưu ý: Giải pháp bên dưới chỉ hoạt động khi cài đặt zip phân phối nguồn hoặc tarball hoặc cài đặt ở chế độ có thể chỉnh sửa từ cây nguồn. Nó sẽ không hoạt động khi cài đặt từ bánh xe nhị phân ( .whl)

Đây là chiến lược duy nhất phù hợp với tôi khi tập lệnh sau cài đặt yêu cầu rằng các gói phụ thuộc đã được cài đặt:

import atexit
from setuptools.command.install import install


def _post_install():
    print('POST INSTALL')


class new_install(install):
    def __init__(self, *args, **kwargs):
        super(new_install, self).__init__(*args, **kwargs)
        atexit.register(_post_install)


setuptools.setup(
    cmdclass={'install': new_install},

Lưu ý: Giải pháp bên dưới chỉ hoạt động khi cài đặt zip phân phối nguồn hoặc tarball hoặc cài đặt ở chế độ có thể chỉnh sửa từ cây nguồn. Nó sẽ không hoạt động khi cài đặt từ bánh xe nhị phân ( .whl)

Một giải pháp có thể là đưa post_setup.pyvào setup.pythư mục của. post_setup.pysẽ chứa một chức năng thực hiện cài đặt sau và setup.pysẽ chỉ nhập và khởi chạy nó vào thời điểm thích hợp.

Trong setup.py:

from distutils.core import setup
from distutils.command.install_data import install_data

try:
    from post_setup import main as post_install
except ImportError:
    post_install = lambda: None

class my_install(install_data):
    def run(self):
        install_data.run(self)
        post_install()

if __name__ == '__main__':
    setup(
        ...
        cmdclass={'install_data': my_install},
        ...
    )

Trong post_setup.py:

def main():
    """Do here your post-install"""
    pass

if __name__ == '__main__':
    main()

Với ý tưởng phổ biến là khởi chạy setup.pytừ thư mục của nó, bạn sẽ có thể nhập post_setup.pykhác, nó sẽ khởi chạy một chức năng trống.

Trong post_setup.py, if __name__ == '__main__':câu lệnh cho phép bạn khởi chạy thủ công sau cài đặt từ dòng lệnh.

Kết hợp các câu trả lời từ @Apalala, @Zulu và @mertyildiran; điều này làm việc cho tôi trong môi trường Python 3.5:

import atexit
import os
import sys
from setuptools import setup
from setuptools.command.install import install

class CustomInstall(install):
    def run(self):
        def _post_install():
            def find_module_path():
                for p in sys.path:
                    if os.path.isdir(p) and my_name in os.listdir(p):
                        return os.path.join(p, my_name)
            install_path = find_module_path()

            # Add your post install code here

        atexit.register(_post_install)
        install.run(self)

setup(
    cmdclass={'install': CustomInstall},
...

Điều này cũng cho phép bạn truy cập vào đường dẫn cài đặt của gói trong đó install_path, để thực hiện một số công việc trên shell.

Tôi nghĩ rằng cách dễ nhất để thực hiện cài đặt sau và giữ các yêu cầu, là trang trí lệnh gọi tới setup(...):

from setup tools import setup


def _post_install(setup):
    def _post_actions():
        do_things()
    _post_actions()
    return setup

setup = _post_install(
    setup(
        name='NAME',
        install_requires=['...
    )
)

Điều này sẽ chạy setup()khi khai báo setup. Sau khi thực hiện quá trình cài đặt yêu cầu, nó sẽ chạy các _post_install()chức năng, mà sẽ chạy các chức năng bên trong _post_actions().

Nếu sử dụng atexit, không cần tạo một cmdclass mới. Bạn chỉ cần tạo đăng ký atexit của mình ngay trước cuộc gọi setup (). Nó làm điều tương tự.

Ngoài ra, nếu bạn cần cài đặt các gói phụ thuộc trước, điều này không hoạt động với cài đặt pip vì trình xử lý atexit của bạn sẽ được gọi trước khi pip chuyển các gói vào vị trí.

Tôi không thể giải quyết vấn đề với bất kỳ đề xuất nào được trình bày, vì vậy đây là những gì đã giúp tôi.

Bạn có thể gọi hàm mà bạn muốn chạy sau khi cài đặt ngay sau khi setup()nhập setup.py, như sau:

from setuptools import setup

def _post_install():
    <your code>

setup(...)

_post_install()