Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-131178: Add CLI tests for profile module#134103
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
ShauryaDusht wants to merge5 commits intopython:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+115 −0
Open
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
115 changes: 115 additions & 0 deletionsLib/test/test_profile.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -4,6 +4,9 @@ | ||
| import pstats | ||
| import unittest | ||
| import os | ||
| import subprocess | ||
| import tempfile | ||
| import shutil | ||
| from difflib import unified_diff | ||
| from io import StringIO | ||
| from test.support.os_helper import TESTFN, unlink, temp_dir, change_cwd | ||
| @@ -131,6 +134,118 @@ def test_output_file_when_changing_directory(self): | ||
| self.assertTrue(os.path.exists('out.pstats')) | ||
| class ProfileCLITests(unittest.TestCase): | ||
| """Tests for the profile module's command line interface.""" | ||
ShauryaDusht marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| def setUp(self): | ||
ShauryaDusht marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| self.temp_dir = tempfile.mkdtemp() | ||
| self.addCleanup(shutil.rmtree, self.temp_dir) | ||
| self.script_content = """\ | ||
| def factorial(n): | ||
| if n <= 1: | ||
| return 1 | ||
| return n * factorial(n-1) | ||
| if __name__ == "__main__": | ||
| factorial(10) | ||
| """ | ||
| self.script_file = os.path.join(self.temp_dir, "factorial_script.py") | ||
| with open(self.script_file, "w") as f: | ||
| f.write(self.script_content) | ||
ShauryaDusht marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| def _run_profile_cli(self, *args): | ||
| cmd = [sys.executable, '-m', 'profile', *args] | ||
| proc = subprocess.Popen( | ||
| cmd, | ||
| stdout=subprocess.PIPE, | ||
| stderr=subprocess.PIPE, | ||
| universal_newlines=True | ||
| ) | ||
| stdout, stderr = proc.communicate() | ||
| return proc.returncode, stdout, stderr | ||
| def test_basic_profile(self): | ||
| returncode, stdout, stderr = self._run_profile_cli(self.script_file) | ||
| self.assertEqual(returncode, 0) | ||
| self.assertIn("function calls", stdout) | ||
| self.assertIn("factorial", stdout) | ||
ShauryaDusht marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| self.assertIn("ncalls", stdout) | ||
| def test_sort_options(self): | ||
| sort_options = ['calls', 'cumulative', 'cumtime', 'file', | ||
| 'filename', 'module', 'ncalls', 'pcalls', | ||
| 'line', 'stdname', 'time', 'tottime'] | ||
| for option in sort_options: | ||
| with self.subTest(sort_option=option): | ||
| returncode, stdout, stderr = self._run_profile_cli( | ||
| '-s', option, self.script_file | ||
| ) | ||
| self.assertEqual(returncode, 0) | ||
| self.assertIn("function calls", stdout) | ||
| def test_output_file(self): | ||
| output_file = os.path.join(self.temp_dir, "profile_output.prof") | ||
| returncode, stdout, stderr = self._run_profile_cli( | ||
| '-o', output_file, self.script_file | ||
| ) | ||
| self.assertEqual(returncode, 0) | ||
| self.assertTrue(os.path.exists(output_file)) | ||
| stats = pstats.Stats(output_file) | ||
| self.assertGreater(stats.total_calls, 0) | ||
| def test_invalid_option(self): | ||
| returncode, stdout, stderr = self._run_profile_cli( | ||
| '--invalid-option', self.script_file | ||
| ) | ||
| self.assertNotEqual(returncode, 0) | ||
| self.assertIn("error", stderr.lower()) | ||
| def test_no_arguments(self): | ||
| returncode, stdout, stderr = self._run_profile_cli() | ||
| self.assertNotEqual(returncode, 0) | ||
| combined_output = stdout.lower() + stderr.lower() | ||
| self.assertTrue( | ||
| "usage:" in combined_output or | ||
| "error:" in combined_output or | ||
| "no script filename specified" in combined_output, | ||
| "Expected usage information or error message not found" | ||
| ) | ||
| def test_run_module(self): | ||
| module_name = "profilemod" | ||
| module_file = os.path.join(self.temp_dir, f"{module_name}.py") | ||
| with open(module_file, "w") as f: | ||
| f.write("print('Module executed')\n") | ||
ShauryaDusht marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| env = os.environ.copy() | ||
| python_path = self.temp_dir | ||
| if 'PYTHONPATH' in env: | ||
| python_path = os.pathsep.join([python_path, env['PYTHONPATH']]) | ||
| env['PYTHONPATH'] = python_path | ||
| cmd = [sys.executable, '-m', 'profile', '-m', module_name] | ||
| proc = subprocess.Popen( | ||
| cmd, | ||
| stdout=subprocess.PIPE, | ||
| stderr=subprocess.PIPE, | ||
| universal_newlines=True, | ||
| env=env | ||
| ) | ||
| stdout, stderr = proc.communicate() | ||
| returncode = proc.returncode | ||
| self.assertEqual(returncode, 0) | ||
| self.assertIn("Module executed", stdout) | ||
| self.assertIn("function calls", stdout) | ||
| def regenerate_expected_output(filename, cls): | ||
| filename = filename.rstrip('co') | ||
| print('Regenerating %s...' % filename) | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.