Ignore some hidden files and folders #131

mzfr · 2018-10-15T17:33:55Z

Fixes #123

Rechi · 2018-10-15T18:58:37Z

Better would be to not exclude all .* files/folders. Just exclude .git explecitly.

mzfr · 2018-10-15T19:04:04Z

But why do we want to process any folder that is hidden?

Rechi · 2018-10-15T19:22:09Z

Because those should be also checked if they contain none allowed files.

razzeee · 2018-10-15T19:35:23Z

I think we're mixing stuff up. If you run it on a single addon, local or in a git source repo, we don't want to process hidden folders. Files should always be processed, only exception is them being in a hidden folder. If we're testing in the repo context those need to be reported and then removed by the person sending the pr.

…

On Mon, 15 Oct 2018, 21:22 Rechi, ***@***.***> wrote: Because those should be also checked if they contain none allowed files. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#131 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFqyZCMSswvAXd3nHAO4ffa0eNJNjj6Cks5ulOBhgaJpZM4XczXb> .

Rechi · 2018-10-15T19:57:26Z

Repo vs single addon seperation is fine for me.

Edit: Is PR check implemented as repo or single addon check?

mzfr · 2018-11-02T14:52:26Z

@razzeee is there any changes required in this?

razzeee · 2018-11-02T15:51:12Z

@Rechi the PR flag get's handed down in both cases and is taken care of in a single check it executes at the moment.

I'm torn now, while I think me design above is correct, it would lead to you running the reporter local/in your git branch and not getting errors. Then sending it to our git and probably getting errors :/

Rechi · 2018-11-13T11:35:10Z

@razzeee what do you think about ignoring files which are marked as export-ignored in git (https://git-scm.com/docs/gitattributes#_creating_an_archive)?

razzeee · 2018-11-13T12:24:08Z

Can you explain how that would help?

Rechi · 2018-11-13T12:38:40Z

It wouldn't ignore all files/folders starting with . by default, but you could exactly define which files/folders to ignore (eg also tests).

razzeee · 2018-11-13T13:49:51Z

I hoped to keep it convention over configuration :/

Rechi · 2018-11-13T14:01:06Z

As long as the check run at xbmc/repo-* doesn't ignore any files, I would be okay with ignoring .* files.
But as you already have mentioned that will cause different results.

razzeee · 2018-11-13T21:52:38Z

I think we need two modes. Additional to PR.

Ignores those files, only used local and in developers repo
Ignores nothing for our xbmc/repo-*

While it's not fun to get new errors when you open the PR version, it's better then having no error reporting at all. If we don't implement it, nobody will use it for their local/dev repos, as they will get false positives all the time.

kodi_addon_checker/handle_files.py

@@ -39,7 +39,8 @@ def create_file_index(path: str):
    file_index = []
    for dirs in os.walk(path):
        for file_name in dirs[2]:
-            file_index.append({"path": dirs[0], "name": file_name})
+            if not file_name.startswith("."):


kodi_addon_checker/handle_files.py

-            file_index.append({"path": dirs[0], "name": file_name})
+    for root, _, files in os.walk(path):
+        for file_name in files:
+            if not file_name.startswith(".") and not os.path.basename(root).startswith("."):


kodi_addon_checker/handle_files.py

@@ -49,7 +49,9 @@ def create_file_index(path: str):
        if ".git" in folders:
            folders.remove(".git")
        for file_name in files:
-            file_index.append({"path": root, "name": file_name})
+            if not os.path.basename(root).startswith("."):


mzfr · 2018-12-10T13:53:50Z

Now, this is what this code is doing:

Say we have the following directory structure:

├── .directory
├── folder1
│   ├── file.py
│   └── .sub_hidden1
└── .hidden
    ├── folder2
    │   ├── .directory
    │   ├── file2.py
    │   └── .sub_hidden2
    └── hidden_file.py

Now if we run this code on the above-mentioned directory we'll get the following file_index

[{'path': '/home/mzfr/dev/Test_folder/folder1', 'name': 'file.py'}, {'path': '/home/mzfr/dev/Test_folder/folder1', 'name': '.sub_hidden1'}, {'path': '/home/mzfr/dev/Test_folder/.hidden/folder2', 'name': '.sub_hidden2'}, {'path': '/home/mzfr/dev/Test_folder/.hidden/folder2', 'name': 'file2.py'}]

I think this is what we want.

Rechi · 2018-12-10T14:00:44Z

The current PR title tells that everything in .hidden directory is ignored too, but the code doesn't ignore it.

Rechi · 2018-12-10T14:02:11Z

kodi_addon_checker/handle_files.py

@@ -46,10 +46,14 @@ def create_file_index(path: str):
    """
    file_index = []
    for root, folders, files in os.walk(path, topdown=True):
+        if ".directory" in files:


Why only skip directories named .directory?

You mean to say we should ignore all the hidden files in the root directory?

What is special about a folder named .directory that it should be ignored, but e.g. not a folder named .abc?
The current code does ignore .directory folders everywhere, not only in the root directory.
The current PR title is "Ignore hidden files and folders", which means ignore all files and folder for me.

.directory is a file, that's why I am checking it in files as

if ".directory" in files:

Also why I am ignoring it? Because I thought since it doesn't have any information usable by us so it would be good to ignore it.

Yes, I named it when I thought we were going to ignore everything. I'll change the name accordingly.

@razzeee @mzfr I still don't get the reason to exclude a file named .directory. What's this special file that it shouldn't be listed in the file index?

This file is basically used by file managers to keep track of the direcotries and also used for the preview of the direcotries.

Why I decided to ignore them? Since these files might be present in the folders(root) of addon but they don't consist any data that can be used by an addon so I simply decided to ignore them.

So it's like .DS_Store and Thumbs.db on other OSes?

Still the checker shouldn't ignore the file, as the checker now doesn't warn about those files submitted in an add-on submission.

mzfr · 2018-12-31T12:52:40Z

@razzeee Is there anything other changes required in this?

Rechi reviewed Nov 14, 2018

View reviewed changes

mzfr force-pushed the hidden-files branch from a2ccced to 3952773 Compare November 14, 2018 13:58

Rechi reviewed Nov 14, 2018

View reviewed changes

kodi_addon_checker/handle_files.py Outdated

file_index.append({"path": dirs[0], "name": file_name})

for root, _, files in os.walk(path):

for file_name in files:

if not file_name.startswith(".") and not os.path.basename(root).startswith("."):

This comment was marked as spam.

Sign in to view

mzfr force-pushed the hidden-files branch 2 times, most recently from 07f3a3f to 98c4095 Compare November 20, 2018 11:33

Rechi reviewed Nov 23, 2018

View reviewed changes

Ignore hidden files and folders

04856cd

mzfr force-pushed the hidden-files branch from 98c4095 to 04856cd Compare December 10, 2018 13:52

Rechi reviewed Dec 10, 2018

View reviewed changes

mzfr changed the title ~~Ignore hidden files and folders~~ Ignore some hidden files and folders Dec 10, 2018

razzeee merged commit 76377d9 into xbmc:master Jan 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ignore some hidden files and folders #131

Ignore some hidden files and folders #131

mzfr commented Oct 15, 2018

Rechi commented Oct 15, 2018

mzfr commented Oct 15, 2018

Rechi commented Oct 15, 2018

razzeee commented Oct 15, 2018 via email

Rechi commented Oct 15, 2018 •

edited

Loading

mzfr commented Nov 2, 2018

razzeee commented Nov 2, 2018

Rechi commented Nov 13, 2018

razzeee commented Nov 13, 2018

Rechi commented Nov 13, 2018

razzeee commented Nov 13, 2018

Rechi commented Nov 13, 2018

razzeee commented Nov 13, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

mzfr commented Dec 10, 2018

Rechi commented Dec 10, 2018

Rechi Dec 10, 2018

mzfr Dec 10, 2018

Rechi Dec 10, 2018

mzfr Dec 10, 2018

Rechi Jan 21, 2019

mzfr Jan 21, 2019

Rechi Jan 22, 2019

mzfr commented Dec 31, 2018

Ignore some hidden files and folders #131

Ignore some hidden files and folders #131

Conversation

mzfr commented Oct 15, 2018

Rechi commented Oct 15, 2018

mzfr commented Oct 15, 2018

Rechi commented Oct 15, 2018

razzeee commented Oct 15, 2018 via email

Rechi commented Oct 15, 2018 • edited Loading

mzfr commented Nov 2, 2018

razzeee commented Nov 2, 2018

Rechi commented Nov 13, 2018

razzeee commented Nov 13, 2018

Rechi commented Nov 13, 2018

razzeee commented Nov 13, 2018

Rechi commented Nov 13, 2018

razzeee commented Nov 13, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

mzfr commented Dec 10, 2018

Rechi commented Dec 10, 2018

Rechi Dec 10, 2018

Choose a reason for hiding this comment

mzfr Dec 10, 2018

Choose a reason for hiding this comment

Rechi Dec 10, 2018

Choose a reason for hiding this comment

mzfr Dec 10, 2018

Choose a reason for hiding this comment

Rechi Jan 21, 2019

Choose a reason for hiding this comment

mzfr Jan 21, 2019

Choose a reason for hiding this comment

Rechi Jan 22, 2019

Choose a reason for hiding this comment

mzfr commented Dec 31, 2018

Rechi commented Oct 15, 2018 •

edited

Loading