Skip to content

Add compliant and noncompliant examples of python/notebook-best-practice-violation@v1.0 #61

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add compliant and noncompliant examples of python/notebook-best-practice-violation@v1.0 #61

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5a913c3
Add compliant and noncompliant examples of python/notebook-best-pract…
ankit-amazon May 8, 2023
94a6652
Improve compliant and noncompliant examples for python/notebook-best-…
ankit-amazon May 9, 2023
b3890d2
Update notebook_best_practice_violation_noncompliant.ipynb
ankit-amazon May 9, 2023
e4b6ee8
Remove ipynb and add py files for python/notebook-best-practice-viola…
ankit-amazon May 19, 2023
f9cd390
Update notebook_best_practice_violation.py
ankit-amazon May 23, 2023
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: 18 additions & 0 deletions .../detectors/notebook_best_practice_violation/notebook_best_practice_violation_compliant.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This rule detects three kinds of violations: empty cell, too many cel, as well as misplaced imports. You need to add them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improved examples.

# SPDX-License-Identifier: Apache-2.0

def __CELL_EDGE__(x):
pass
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the CELL_EDGE markers



# {fact rule=notebook-best-practice-violation@v1.0 defects=0}
# Compliant: cell is not blank.
__CELL_EDGE__(0)
x = 12
__CELL_EDGE__(1)
y = 13
__CELL_EDGE__(2)
sum = x + y
__CELL_EDGE__(3)
print('End of program')
# {/fact}
20 changes: 20 additions & 0 deletions ...tectors/notebook_best_practice_violation/notebook_best_practice_violation_noncompliant.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need separate files for compliant and non compliant? Can these be in the same .py file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to cover all three types of violation(blank cell, cell limit, misplaced imports) in one file is not possible. Is it ok if we create separate files for each example?

# SPDX-License-Identifier: Apache-2.0

def __CELL_EDGE__(x):
pass


# {fact rule=notebook-best-practice-violation@v1.0 defects=1}
# Noncompliant: cell is blank.
__CELL_EDGE__(0)

__CELL_EDGE__(1)
x = 12
__CELL_EDGE__(2)
y = 13
__CELL_EDGE__(3)
sum = x + y
__CELL_EDGE__(4)
print('End of program')
# {/fact}