Add script for detecting bad characters. #27315

s-kawamura-w664 · 2021-03-30T07:43:12Z

This is script that find control-code(0x00-0x1f) in text files.
I could find them in several files. Please look at PR #26965, #27173, #27171.

netlify · 2021-03-30T07:55:36Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 7fde042

https://deploy-preview-27315--kubernetes-io-master-staging.netlify.app

sftim

Nice idea

We could run this as a CI test, in fact.

s-ito-ts · 2021-04-01T01:59:11Z

Could you add how to use this script to the README?
https://github.com/kubernetes/website/blob/master/scripts/README.md

oomichi · 2021-04-01T17:53:23Z

We could run this as a CI test, in fact.

@sftim That is a nice idea.
Do you know how to enable some script on CI test of this website repo?
On kubernetes/kubernetes repo, hack/verify-***.sh files are distinguished as CI testing scripts and these scripts are automatically operated. But I could not find such way on this repo.

/cc @oomichi

s-kawamura-w664 · 2021-04-02T07:54:07Z

@s-ito-ts
I updated README.md.
Could you please review?

Could you add how to use this script to the README?
https://github.com/kubernetes/website/blob/master/scripts/README.md

oomichi

some comments to make the code more readable.

oomichi · 2021-04-02T16:07:10Z

scripts/check-ctrlcode.py

+
+def check_dir(path, ext):
+    for f in os.listdir(path):
+        if(f[0] != "."):


To reduce nests, here can be

if(f[0] == "."): continue fullpath = os.path.join(path, f) ...

oomichi · 2021-04-02T16:09:27Z

scripts/check-ctrlcode.py

+            fullpath = os.path.join(path, f)
+            if(os.path.isfile(fullpath)):
+                exts = os.path.splitext(f)
+                if(exts[1] == ext):


ditto:

if(exts[1] != ext): continue check_ctrlcode(fullpath)

oomichi · 2021-04-02T16:13:13Z

scripts/check-ctrlcode.py

+    with open(filepath, encoding='utf-8') as f:
+        while True:
+            str = f.readline()
+            if str:


ditto:

if str == "": break line = line + 1 # check 0x00-0x1f except 0x09(HT), 0x0a(LF), 0x0d(CR) ...

oomichi · 2021-04-02T16:14:27Z

scripts/check-ctrlcode.py

+                # check 0x00-0x1f except 0x09(HT), 0x0a(LF), 0x0d(CR)
+                pattern = re.compile('[\u0000-\u0008\u000b\u000c\u000e-\u001f]')
+                m = pattern.search(str)
+                if(m != None):


ditto:

if(m == None): continue pos = m.end() ctrl = m.group().encode("utf-8") ...

s-kawamura-w664 · 2021-04-06T05:54:30Z

some comments to make the code more readable.

@oomichi
I fixed them according to your review comment.
Could you please review my fixes?

oomichi

Thanks for updating.
Most part seems good for me, just one comment.

oomichi · 2021-04-06T21:32:20Z

scripts/check-ctrlcode.py

+                continue
+            check_ctrlcode(fullpath)
+        else:
+            check_dir(fullpath, ext)


similar point. How about changing line 30-34 to

if(os.path.isdir(fullpath)): check_dir(fullpath, ext) continue exts = os.path.splitext(f) if(exts[1] != ext): continue check_ctrlcode(fullpath)

?

I don't think nest is a problem.
I thought about the ease of understanding the conditions.
My code feels easy to understand the if-else condition.
Your code feels easy to understand as a loop condition.
I would like to accept your proposal and fix it.
After fixed, I'll request you to review.

This point is not only for nest.
This point makes condition same as the next called function.
In my suggestion, isdir() condition calls check_dir().
I think that is pretty straightforward and easy to understand what is the purpose here.

Co-authored-by: Shu Muto <shu.mutow@nec.com>

s-kawamura-w664 · 2021-04-08T09:51:08Z

Thanks for updating.
Most part seems good for me, just one comment.

@oomichi
Thanks for your comment.
I fixed it.
Could you please review my fixes?

oomichi

Thanks for updating.

/lgtm

k8s-ci-robot · 2021-04-08T14:41:14Z

LGTM label has been added.

Git tree hash: 73d9393f4624ed62b81eb568c45ad201cf84c7a2

s-kawamura-w664 · 2021-04-09T07:44:48Z

/assign @steveperry-53

Could you please review?
If this is OK, please approve.

savitharaghunathan

/approve

k8s-ci-robot · 2021-05-10T22:11:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: savitharaghunathan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [savitharaghunathan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 30, 2021

k8s-ci-robot requested review from celestehorgan and kbarnard10 March 30, 2021 07:43

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 30, 2021

sftim reviewed Mar 30, 2021

View reviewed changes

k8s-ci-robot requested a review from oomichi April 1, 2021 17:53

s-kawamura-w664 force-pushed the patch-script branch from b85da54 to 6d728ec Compare April 2, 2021 07:37

oomichi reviewed Apr 2, 2021

View reviewed changes

s-kawamura-w664 force-pushed the patch-script branch from 6d728ec to fc68dcb Compare April 6, 2021 04:36

oomichi reviewed Apr 6, 2021

View reviewed changes

Add script for detecting bad characters.

7fde042

Co-authored-by: Shu Muto <shu.mutow@nec.com>

s-kawamura-w664 force-pushed the patch-script branch from fc68dcb to 7fde042 Compare April 8, 2021 09:39

oomichi reviewed Apr 8, 2021

View reviewed changes

k8s-ci-robot assigned oomichi Apr 8, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 8, 2021

k8s-ci-robot assigned steveperry-53 Apr 9, 2021

savitharaghunathan reviewed May 10, 2021

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 10, 2021

k8s-ci-robot merged commit 448df54 into kubernetes:master May 10, 2021

s-kawamura-w664 mentioned this pull request Jun 23, 2021

REQUEST: New membership for @s-kawamura-w664 kubernetes/org#2803

Closed

6 tasks

s-kawamura-w664 deleted the patch-script branch October 19, 2022 04:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add script for detecting bad characters. #27315

Add script for detecting bad characters. #27315

s-kawamura-w664 commented Mar 30, 2021

netlify bot commented Mar 30, 2021 •

edited

Loading

sftim left a comment

s-ito-ts commented Apr 1, 2021

oomichi commented Apr 1, 2021

s-kawamura-w664 commented Apr 2, 2021

oomichi left a comment

oomichi Apr 2, 2021

oomichi Apr 2, 2021

oomichi Apr 2, 2021

oomichi Apr 2, 2021

s-kawamura-w664 commented Apr 6, 2021

oomichi left a comment

oomichi Apr 6, 2021

s-kawamura-w664 Apr 7, 2021

oomichi Apr 7, 2021 •

edited

Loading

s-kawamura-w664 commented Apr 8, 2021

oomichi left a comment

k8s-ci-robot commented Apr 8, 2021

s-kawamura-w664 commented Apr 9, 2021

savitharaghunathan left a comment

k8s-ci-robot commented May 10, 2021

Add script for detecting bad characters. #27315

Add script for detecting bad characters. #27315

Conversation

s-kawamura-w664 commented Mar 30, 2021

netlify bot commented Mar 30, 2021 • edited Loading

sftim left a comment

Choose a reason for hiding this comment

s-ito-ts commented Apr 1, 2021

oomichi commented Apr 1, 2021

s-kawamura-w664 commented Apr 2, 2021

oomichi left a comment

Choose a reason for hiding this comment

oomichi Apr 2, 2021

Choose a reason for hiding this comment

oomichi Apr 2, 2021

Choose a reason for hiding this comment

oomichi Apr 2, 2021

Choose a reason for hiding this comment

oomichi Apr 2, 2021

Choose a reason for hiding this comment

s-kawamura-w664 commented Apr 6, 2021

oomichi left a comment

Choose a reason for hiding this comment

oomichi Apr 6, 2021

Choose a reason for hiding this comment

s-kawamura-w664 Apr 7, 2021

Choose a reason for hiding this comment

oomichi Apr 7, 2021 • edited Loading

Choose a reason for hiding this comment

s-kawamura-w664 commented Apr 8, 2021

oomichi left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 8, 2021

s-kawamura-w664 commented Apr 9, 2021

savitharaghunathan left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 10, 2021

netlify bot commented Mar 30, 2021 •

edited

Loading

oomichi Apr 7, 2021 •

edited

Loading