Skip to content

fix: replace python with python3, use -m #866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
apotterri merged 1 commit into from
Nov 21, 2022
Merged

fix: replace python with python3, use -m #866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions packages/cli/src/cmds/agentInstaller/pythonAgentInstaller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ abstract class PythonInstaller extends AgentInstaller {
async environment(): Promise<Record<string, string>> {
// Python version is returned as a string similar to:
// Python 3.7.0
const version = await getOutput('python', ['--version'], this.path);
const version = await getOutput('python3', ['--version'], this.path);
const pythonPath = await getOutput(
'python',
'python3',
['-c', 'import sys; print(sys.prefix)'],
this.path
);
Expand Down Expand Up @@ -158,11 +158,11 @@ export class PipInstaller extends PythonInstaller {
}

async checkConfigCommand(): Promise<CommandStruct | undefined> {
let commandArgs = ['install', '-r', this.buildFile];
let commandArgs = ['-m', 'pip', 'install', '-r', this.buildFile];
let supportsDryRun: boolean;

try {
const pipVersionOutput = await getOutput('pip', ['--version'], this.path);
const pipVersionOutput = await getOutput('python3', ['-m', 'pip', '--version'], this.path);
const pipVersion = semver.coerce(pipVersionOutput.output);

if (!pipVersion) {
Expand All @@ -178,7 +178,7 @@ export class PipInstaller extends PythonInstaller {
commandArgs.push('--dry-run');
}

return new CommandStruct('pip', commandArgs, this.path);
return new CommandStruct('python3', commandArgs, this.path);
}

async installAgent(): Promise<void> {
Expand All @@ -198,12 +198,16 @@ export class PipInstaller extends PythonInstaller {

encodedFile.write(requirements);

const cmd = new CommandStruct('pip', ['install', '-r', this.buildFile], this.path);
const cmd = new CommandStruct(
'python3',
['-m', 'pip', 'install', '-r', this.buildFile],
this.path
);
await run(cmd);
}

async initCommand(): Promise<CommandStruct> {
return new CommandStruct('appmap-agent-init', [], this.path);
return new CommandStruct('python3', ['-m', 'appmap.command.appmap_agent_init'], this.path);
}

async verifyCommand() {
Expand Down
32 changes: 16 additions & 16 deletions packages/cli/tests/unit/agentInstall/installCommand.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,13 +466,13 @@ packages:

describe('A Python project', () => {
const pythonVersion = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('python');
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['--version']);
return Promise.resolve({ stdout: 'Python 3.7.0', stderr: '' });
};

const pythonPath = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('python');
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['-c', "'import sys; print(sys.prefix)'"]);
return Promise.resolve({ stdout: '/usr/local', stderr: '' });
};
Expand Down Expand Up @@ -521,15 +521,15 @@ packages:
});

const installAgent = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('pip');
expect(cmdStruct.args).toEqual(['install', '-r', 'requirements.txt']);
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['-m', 'pip', 'install', '-r', 'requirements.txt']);
const ret = { stdout: '', stderr: '' };
return Promise.resolve(ret);
};

const initAgent = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('appmap-agent-init');
expect(cmdStruct.args.length).toEqual(0);
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['-m', 'appmap.command.appmap_agent_init']);
const fakeConfig = `
{
"configuration": {
Expand All @@ -542,8 +542,8 @@ packages:

describe('below version 22.2.0', () => {
const pipVersion = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('pip');
expect(cmdStruct.args).toEqual(['--version']);
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['-m', 'pip', '--version']);
return Promise.resolve({
stdout:
'pip 22.0 from /home/user/.pyenv/versions/3.7.0/lib/python3.7/site-packages/pip (python 3.7)',
Expand All @@ -552,9 +552,9 @@ packages:
};

const checkCurrentConfig = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('pip');
expect(cmdStruct.program).toEqual('python3');
const args = cmdStruct.args;
expect(args).toEqual(['install', '-r', 'requirements.txt']);
expect(args).toEqual(['-m', 'pip', 'install', '-r', 'requirements.txt']);
const ret = { stdout: '', stderr: '' };
return Promise.resolve(ret);
};
Expand Down Expand Up @@ -583,14 +583,14 @@ packages:

describe('above version 22.2.0', () => {
const pythonVersion = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('python');
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['--version']);
return Promise.resolve({ stdout: 'Python 3.10.7', stderr: '' });
};

const pipVersion = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('pip');
expect(cmdStruct.args).toEqual(['--version']);
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['-m', 'pip', '--version']);
return Promise.resolve({
stdout:
'pip 22.2.2 from /home/user/.pyenv/versions/3.10.7/lib/python3.7/site-packages/pip (python 3.10)',
Expand All @@ -599,9 +599,9 @@ packages:
};

const checkCurrentConfig = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('pip');
expect(cmdStruct.program).toEqual('python3');
const args = cmdStruct.args;
expect(args).toEqual(['install', '-r', 'requirements.txt', '--dry-run']);
expect(args).toEqual(['-m', 'pip', 'install', '-r', 'requirements.txt', '--dry-run']);
const ret = { stdout: '', stderr: '' };
return Promise.resolve(ret);
};
Expand Down Expand Up @@ -658,7 +658,7 @@ packages:
};

const pythonVersion = (cmdStruct: CommandStruct) => {
expect(cmdStruct.program).toEqual('python');
expect(cmdStruct.program).toEqual('python3');
expect(cmdStruct.args).toEqual(['--version']);
return Promise.resolve({ stdout: 'Python 3.7.0', stderr: '' });
};
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/tests/unit/agentInstall/python.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ describe('Python Agent Installation', () => {

it('provides the correct init command', async () => {
const cmdStruct = await btInstaller.initCommand();
expect(cmdStruct.program).toBe('appmap-agent-init');
expect(cmdStruct.args).toEqual([]);
expect(cmdStruct.program).toBe('python3');
expect(cmdStruct.args).toEqual(['-m', 'appmap.command.appmap_agent_init']);
});
});

Expand Down