Creating an egg as a distribution? about pygradle

[JLLeitschuh]

I solved this problem by creating my own task and plugin in gradle that imports this plugin.

Here's the code I used to fix this problem for anyone else that needs it (both are in groovy in our buildSrc project).

You'll have to add the imports yourself.

class PythonEggDistributionPlugin extends PythonBasePlugin {
    public final static String TASK_PACKAGE_EGG_DIST = 'packageEggDist'

    @Override
    void applyTo(Project project) {

        /**
         * Create a Python source distribution.
         */
        def eggDistPackageTask = project.tasks.create(TASK_PACKAGE_EGG_DIST, SourceEggTask) {
            dependsOn(project.tasks.getByName(PythonPlugin.TASK_INSTALL_PROJECT))
        }

        def eggDistArtifactInfo = [
                name: project.name,
                type: 'egg',
                extension: 'egg',
                file: eggDistPackageTask.getEggDistOutput(),
                builtBy: project.tasks.getByName(TASK_PACKAGE_EGG_DIST),
        ]

        project.artifacts.add(PythonPlugin.CONFIGURATION_DEFAULT, eggDistArtifactInfo)
    }
}

/**
 * A task that allows us to create a python egg piggy backing on the linkedin python plugin
 */
class SourceEggTask extends DefaultTask implements FailureReasonProvider {

    private final TeeOutputContainer container = new TeeOutputContainer();

    @TaskAction
    public void packageEggDist() {
        // Fixes a groovy scoping problem
        final TeeOutputContainer containerAlias = container

        final PythonExtension settings = getProject().getExtensions().getByType(PythonExtension.class);

        getProject().exec(new Action<ExecSpec>() {
            @Override
            public void execute(ExecSpec execSpec) {
                containerAlias.setOutputs(execSpec);
                execSpec.environment(settings.pythonEnvironmentDistgradle);
                execSpec.commandLine(
                        VirtualEnvExecutableHelper.getPythonInterpreter(settings.getDetails()),
                        "setup.py",
                        "bdist_egg",
                        "--dist-dir",
                        getDistDir().getAbsolutePath());
            }
        });
    }

    @OutputFile
    public File getEggDistOutput() {
        Project project = getProject();
        return new File(getDistDir(),
                String.format(
                        "%s-%s-py2.7.egg",
                        project.getName(),
                        /*
                         * For some reason the build spits out a file with
                         *  the `-` character replaced by the `_` character.
                         */
                        project.getVersion().toString().replace("-", "_")));
    }

    private File getDistDir() {
        return new File(getProject().getBuildDir(), "distributions");
    }

    @Override
    public String getReason() {
        return container.getCommandOutput();
    }
}

[JLLeitschuh]

Note: I originally had the getEggDistOutput method wrong. I have since fixed it as you can see above.

[JLLeitschuh]

Updated version for newest release of plugin:

class SourceEggTask extends AbstractPythonMainSourceDefaultTask {

    public SourceEggTask() {
        args("setup.py",
                "bdist_egg",
                "--dist-dir",
                getDistDir().getAbsolutePath())
    }

    @Override
    public void processResults(ExecResult execResult) {
    }

    @OutputFile
    public File getEggDistOutput() {
        Project project = getProject();
        return new File(getDistDir(),
                String.format(
                        "%s-%s-py2.7.egg",
                        project.getName(),
                        /*
                         * For some reason the build spits out a file with
                         *  the `-` character replaced by the `_` character.
                         */
                        project.getVersion().toString().replace("-", "_")));
    }


    private File getDistDir() {
        return new File(getProject().getBuildDir(), "distributions");
    }
}