สคริปต์หลังการติดตั้งด้วย Python setuptools

เป็นไปได้หรือไม่ที่จะระบุไฟล์สคริปต์ Python หลังการติดตั้งเป็นส่วนหนึ่งของไฟล์ setuptools setup.py เพื่อให้ผู้ใช้สามารถรันคำสั่ง:

python setup.py install

บนที่เก็บไฟล์โปรเจ็กต์ในเครื่องหรือ

pip install <name>

สำหรับโครงการ PyPI และสคริปต์จะทำงานเมื่อเสร็จสิ้นการติดตั้ง setuptools มาตรฐาน? ฉันต้องการดำเนินการหลังการติดตั้งที่สามารถเข้ารหัสในไฟล์สคริปต์ Python ไฟล์เดียว (เช่นส่งข้อความหลังการติดตั้งที่กำหนดเองไปยังผู้ใช้ดึงไฟล์ข้อมูลเพิ่มเติมจากที่เก็บแหล่งข้อมูลระยะไกลอื่น)

ฉันเจอคำตอบ SO นี้เมื่อหลายปีก่อนที่กล่าวถึงหัวข้อและดูเหมือนว่าฉันทามติในเวลานั้นคือคุณต้องสร้างคำสั่งย่อยการติดตั้ง หากยังคงเป็นเช่นนั้นจะเป็นไปได้หรือไม่ที่ใครบางคนจะให้ตัวอย่างวิธีการดำเนินการนี้โดยที่ผู้ใช้ไม่จำเป็นต้องป้อนคำสั่งที่สองเพื่อรันสคริปต์

หมายเหตุ:โซลูชันด้านล่างใช้ได้เฉพาะเมื่อติดตั้ง zip การแจกจ่ายต้นทางหรือ tarball หรือติดตั้งในโหมดที่แก้ไขได้จากแผนผังต้นทาง จะไม่ทำงานเมื่อติดตั้งจากวงล้อไบนารี ( .whl)

โซลูชันนี้มีความโปร่งใสมากขึ้น:

คุณจะเพิ่มข้อมูลเล็กน้อยsetup.pyและไม่จำเป็นต้องมีไฟล์เพิ่มเติม

นอกจากนี้คุณต้องพิจารณาการติดตั้งหลังการติดตั้งที่แตกต่างกันสองแบบ หนึ่งสำหรับโหมดพัฒนา / แก้ไขและอีกโหมดหนึ่งสำหรับโหมดติดตั้ง

เพิ่มสองคลาสที่มีสคริปต์หลังการติดตั้งของคุณไปที่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

และแทรกcmdclassอาร์กิวเมนต์ให้กับsetup()ฟังก์ชันในsetup.py:

setup(
    ...

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

    ...
)

คุณสามารถเรียกคำสั่งเชลล์ระหว่างการติดตั้งได้เช่นในตัวอย่างนี้ซึ่งเป็นการเตรียมการก่อนการติดตั้ง:

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(
    ...

ปล. ไม่มีจุดเข้าใช้งานก่อนการติดตั้งใน setuptools อ่านการสนทนานี้หากคุณสงสัยว่าเหตุใดจึงไม่มี

หมายเหตุ:โซลูชันด้านล่างใช้ได้เฉพาะเมื่อติดตั้ง zip การแจกจ่ายต้นทางหรือ tarball หรือติดตั้งในโหมดที่แก้ไขได้จากแผนผังต้นทาง จะไม่ทำงานเมื่อติดตั้งจากวงล้อไบนารี ( .whl)

นี่เป็นกลยุทธ์เดียวที่ใช้ได้ผลสำหรับฉันเมื่อสคริปต์หลังการติดตั้งต้องการให้ติดตั้งการอ้างอิงแพ็กเกจแล้ว:

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},

หมายเหตุ:โซลูชันด้านล่างใช้ได้เฉพาะเมื่อติดตั้ง zip การแจกจ่ายต้นทางหรือ tarball หรือติดตั้งในโหมดที่แก้ไขได้จากแผนผังต้นทาง จะไม่ทำงานเมื่อติดตั้งจากวงล้อไบนารี ( .whl)

วิธีการแก้ปัญหาอาจจะรวมถึงpost_setup.pyในsetup.pyไดเรกทอรี 's post_setup.pyจะมีฟังก์ชันที่ทำหลังการติดตั้งและsetup.pyจะนำเข้าและเปิดใช้งานในเวลาที่เหมาะสมเท่านั้น

ใน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},
        ...
    )

ในpost_setup.py:

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

if __name__ == '__main__':
    main()

ด้วยแนวคิดทั่วไปในการเปิดใช้งานsetup.pyจากไดเร็กทอรีคุณจะสามารถนำเข้าได้post_setup.pyมิฉะนั้นจะเปิดฟังก์ชันว่าง

ในpost_setup.pyการif __name__ == '__main__':คำสั่งช่วยให้คุณสามารถเปิดตัวด้วยตนเองหลังการติดตั้งจากบรรทัดคำสั่ง

รวมคำตอบจาก @Apalala, @Zulu และ @mertyildiran; สิ่งนี้ใช้ได้กับฉันในสภาพแวดล้อม 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},
...

นอกจากนี้ยังช่วยให้คุณเข้าถึงเส้นทางการติดตั้งของแพ็กเกจในinstall_pathเพื่อทำงานเชลล์

ฉันคิดว่าวิธีที่ง่ายที่สุดในการดำเนินการหลังการติดตั้งและรักษาข้อกำหนดคือการตกแต่งการโทรไปที่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=['...
    )
)

นี้จะทำงานเมื่อประกาศsetup() setupเมื่อทำได้ด้วยการติดตั้งความต้องการก็จะเรียกใช้ฟังก์ชั่นซึ่งจะทำงานฟังก์ชั่นภายใน_post_install()_post_actions()

หากใช้ atexit ไม่จำเป็นต้องสร้าง cmdclass ใหม่ คุณสามารถสร้างการลงทะเบียน atexit ของคุณได้ทันทีก่อนการเรียก setup () มันทำสิ่งเดียวกัน

นอกจากนี้หากคุณต้องการการติดตั้งการอ้างอิงก่อนสิ่งนี้จะใช้ไม่ได้กับการติดตั้ง pip เนื่องจากตัวจัดการ atexit ของคุณจะถูกเรียกก่อนที่ pip จะย้ายแพ็คเกจเข้าที่

ฉันไม่สามารถแก้ปัญหาด้วยคำแนะนำที่นำเสนอได้ดังนั้นนี่คือสิ่งที่ช่วยฉันได้

คุณสามารถเรียกใช้ฟังก์ชันที่คุณต้องการเรียกใช้หลังจากการติดตั้งsetup()ในภายหลังsetup.pyเช่น:

from setuptools import setup

def _post_install():
    <your code>

setup(...)

_post_install()