starred/hosts
1
0
Fork 0
mirror of https://github.com/StevenBlack/hosts.git synced 2026-09-24 22:05:14 +01:00
Code Issues Packages Projects Releases 10 Wiki Activity

Use example files to allow proper git-ignoring

Browse Source 
The following files:

* myhosts
* blacklist
* whitelist

can be all be modified by the user for personal usage.
However, git is tracking these files since they exist
in the repository, which makes it difficult to do so
without accidentally pushing one's own customizations.

This commit converts those examples to ".example" files,
which serve as the defaults if one of the files listed
above does not exist.

Closes gh-144.
This commit is contained in:
gfyoung
2018-09-06 12:20:37 -07:00
parent fbbd071611
commit d8df5f1dc4
5 changed files with 40 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
updateHostsFile.py
+31 -12
View File
@@ -641,9 +641,10 @@ def create_initial_file():
with open(filename, "r") as curFile:
write_data(merge_file, curFile.read())
if os.path.isfile(settings["blacklistfile"]):
with open(settings["blacklistfile"], "r") as curFile:
write_data(merge_file, curFile.read())
maybe_copy_example_file(settings["blacklistfile"])
with open(settings["blacklistfile"], "r") as curFile:
write_data(merge_file, curFile.read())
return merge_file
@@ -739,12 +740,13 @@ def remove_dups_and_excl(merge_file, exclusion_regexes, output_file=None):
"""
number_of_rules = settings["numberofrules"]
if os.path.isfile(settings["whitelistfile"]):
with open(settings["whitelistfile"], "r") as ins:
for line in ins:
line = line.strip(" \t\n\r")
if line and not line.startswith("#"):
settings["exclusions"].append(line)
maybe_copy_example_file(settings["whitelistfile"])
with open(settings["whitelistfile"], "r") as ins:
for line in ins:
line = line.strip(" \t\n\r")
if line and not line.startswith("#"):
settings["exclusions"].append(line)
if not os.path.exists(settings["outputpath"]):
os.makedirs(settings["outputpath"])
@@ -956,10 +958,10 @@ def write_opening_header(final_file, **header_params):
write_data(final_file, "\n")
preamble = path_join_robust(BASEDIR_PATH, "myhosts")
maybe_copy_example_file(preamble)
if os.path.isfile(preamble):
with open(preamble, "r") as f:
write_data(final_file, f.read())
with open(preamble, "r") as f:
write_data(final_file, f.read())
final_file.write(file_contents)
@@ -1213,6 +1215,23 @@ def domain_to_idna(line):
# Helper Functions
def maybe_copy_example_file(file_path):
"""
Given a file path, copy over its ".example" if the path doesn't exist.
If the path does exist, nothing happens in this function.
Parameters
----------
file_path : str
The full file path to check.
"""
if not os.path.isfile(file_path):
example_file_path = file_path + ".example"
shutil.copyfile(example_file_path, file_path)
def get_file_by_url(url):
"""
Get a file data located at a particular URL.