mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #7521 from ThomasWaldmann/fix-argparse-errors-master 

Fix argparse error messages
This commit is contained in:
TW 2023-04-15 15:08:07 +02:00 committed by GitHub
parent 81e618ba28 0b40e038ad
commit 9263705de7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 40 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/borg/compress.pyx
View File

@ -15,6 +15,7 @@ which compressor has been used to compress the data and dispatch to the correct
decompressor.
"""
from argparse import ArgumentTypeError
import random
from struct import Struct
import zlib
@ -652,7 +653,7 @@ class CompressionSpec:
values = s.split(',')
count = len(values)
if count < 1:
raise ValueError
raise ArgumentTypeError("not enough arguments")
# --compression algo[,level]
self.name = values[0]
if self.name in ('none', 'lz4', ):
@ -663,9 +664,9 @@ class CompressionSpec:
elif count == 2:
level = int(values[1])
if not 0 <= level <= 9:
raise ValueError
raise ArgumentTypeError("level must be >= 0 and <= 9")
else:
raise ValueError
raise ArgumentTypeError("too many arguments")
self.level = level
elif self.name in ('zstd', ):
if count < 2:
@ -673,28 +674,28 @@ class CompressionSpec:
elif count == 2:
level = int(values[1])
if not 1 <= level <= 22:
raise ValueError
raise ArgumentTypeError("level must be >= 1 and <= 22")
else:
raise ValueError
raise ArgumentTypeError("too many arguments")
self.level = level
elif self.name == 'auto':
if 2 <= count <= 3:
compression = ','.join(values[1:])
else:
raise ValueError
raise ArgumentTypeError("bad arguments")
self.inner = CompressionSpec(compression)
elif self.name == 'obfuscate':
if 3 <= count <= 5:
level = int(values[1])
if not ((1 <= level <= 6) or (110 <= level <= 123)):
raise ValueError
raise ArgumentTypeError("level must be >= 1 and <= 6 or >= 110 and <= 123")
self.level = level
compression = ','.join(values[2:])
else:
raise ValueError
raise ArgumentTypeError("bad arguments")
self.inner = CompressionSpec(compression)
else:
raise ValueError
raise ArgumentTypeError("unsupported compression type")
@property
def compressor(self):

28
src/borg/helpers/parseformat.py
View File

@ -137,7 +137,7 @@ def ChunkerParams(s):
params = s.strip().split(",")
count = len(params)
if count == 0:
raise ValueError("no chunker params given")
raise argparse.ArgumentTypeError("no chunker params given")
algo = params[0].lower()
if algo == CH_FAIL and count == 3:
block_size = int(params[1])
@ -152,9 +152,11 @@ def ChunkerParams(s):
# or in-memory chunk management.
# choose the block (chunk) size wisely: if you have a lot of data and you cut
# it into very small chunks, you are asking for trouble!
raise ValueError("block_size must not be less than 64 Bytes")
raise argparse.ArgumentTypeError("block_size must not be less than 64 Bytes")
if block_size > MAX_DATA_SIZE or header_size > MAX_DATA_SIZE:
raise ValueError("block_size and header_size must not exceed MAX_DATA_SIZE [%d]" % MAX_DATA_SIZE)
raise argparse.ArgumentTypeError(
"block_size and header_size must not exceed MAX_DATA_SIZE [%d]" % MAX_DATA_SIZE
)
return algo, block_size, header_size
if algo == "default" and count == 1: # default
return CHUNKER_PARAMS
@ -162,14 +164,18 @@ def ChunkerParams(s):
if algo == CH_BUZHASH and count == 5 or count == 4: # [buzhash, ]chunk_min, chunk_max, chunk_mask, window_size
chunk_min, chunk_max, chunk_mask, window_size = (int(p) for p in params[count - 4 :])
if not (chunk_min <= chunk_mask <= chunk_max):
raise ValueError("required: chunk_min <= chunk_mask <= chunk_max")
raise argparse.ArgumentTypeError("required: chunk_min <= chunk_mask <= chunk_max")
if chunk_min < 6:
# see comment in 'fixed' algo check
raise ValueError("min. chunk size exponent must not be less than 6 (2^6 = 64B min. chunk size)")
raise argparse.ArgumentTypeError(
"min. chunk size exponent must not be less than 6 (2^6 = 64B min. chunk size)"
)
if chunk_max > 23:
raise ValueError("max. chunk size exponent must not be more than 23 (2^23 = 8MiB max. chunk size)")
raise argparse.ArgumentTypeError(
"max. chunk size exponent must not be more than 23 (2^23 = 8MiB max. chunk size)"
)
return CH_BUZHASH, chunk_min, chunk_max, chunk_mask, window_size
raise ValueError("invalid chunker params")
raise argparse.ArgumentTypeError("invalid chunker params")
def FilesCacheMode(s):
@ -177,11 +183,13 @@ def FilesCacheMode(s):
VALID_MODES = ("cis", "ims", "cs", "ms", "cr", "mr", "d", "s") # letters in alpha order
entries = set(s.strip().split(","))
if not entries <= set(ENTRIES_MAP):
raise ValueError("cache mode must be a comma-separated list of: %s" % ",".join(sorted(ENTRIES_MAP)))
raise argparse.ArgumentTypeError(
"cache mode must be a comma-separated list of: %s" % ",".join(sorted(ENTRIES_MAP))
)
short_entries = {ENTRIES_MAP[entry] for entry in entries}
mode = "".join(sorted(short_entries))
if mode not in VALID_MODES:
raise ValueError("cache mode short must be one of: %s" % ",".join(VALID_MODES))
raise argparse.ArgumentTypeError("cache mode short must be one of: %s" % ",".join(VALID_MODES))
return mode
@ -277,7 +285,7 @@ def SortBySpec(text):
for token in text.split(","):
if token not in AI_HUMAN_SORT_KEYS:
raise ValueError("Invalid sort key: %s" % token)
raise argparse.ArgumentTypeError("Invalid sort key: %s" % token)
return text.replace("timestamp", "ts")

9
src/borg/testsuite/compress.py
View File

@ -1,3 +1,4 @@
import argparse
import os
import zlib
@ -226,7 +227,7 @@ def test_obfuscate_meta():
def test_compression_specs():
with pytest.raises(ValueError):
with pytest.raises(argparse.ArgumentTypeError):
CompressionSpec("")
assert isinstance(CompressionSpec("none").compressor, CNONE)
@ -241,7 +242,7 @@ def test_compression_specs():
zlib = CompressionSpec("zlib,9").compressor
assert isinstance(zlib, ZLIB)
assert zlib.level == 9
with pytest.raises(ValueError):
with pytest.raises(argparse.ArgumentTypeError):
CompressionSpec("zlib,9,invalid")
lzma = CompressionSpec("lzma").compressor
@ -264,7 +265,7 @@ def test_compression_specs():
assert isinstance(zstd, ZSTD)
assert zstd.level == 22
with pytest.raises(ValueError):
with pytest.raises(argparse.ArgumentTypeError):
CompressionSpec("lzma,9,invalid")
with pytest.raises(ValueError):
with pytest.raises(argparse.ArgumentTypeError):
CompressionSpec("invalid")

14
src/borg/testsuite/helpers.py
View File

@ -368,19 +368,19 @@ def test_chunkerparams():
assert ChunkerParams("fixed,4096") == ("fixed", 4096, 0)
assert ChunkerParams("fixed,4096,200") == ("fixed", 4096, 200)
# invalid values checking
with pytest.raises(ValueError):
with pytest.raises(ArgumentTypeError):
ChunkerParams("crap,1,2,3,4") # invalid algo
with pytest.raises(ValueError):
with pytest.raises(ArgumentTypeError):
ChunkerParams("buzhash,5,7,6,4095") # too small min. size
with pytest.raises(ValueError):
with pytest.raises(ArgumentTypeError):
ChunkerParams("buzhash,19,24,21,4095") # too big max. size
with pytest.raises(ValueError):
with pytest.raises(ArgumentTypeError):
ChunkerParams("buzhash,23,19,21,4095") # violates min <= mask <= max
with pytest.raises(ValueError):
with pytest.raises(ArgumentTypeError):
ChunkerParams("fixed,63") # too small block size
with pytest.raises(ValueError):
with pytest.raises(ArgumentTypeError):
ChunkerParams("fixed,%d,%d" % (MAX_DATA_SIZE + 1, 4096)) # too big block size
with pytest.raises(ValueError):
with pytest.raises(ArgumentTypeError):
ChunkerParams("fixed,%d,%d" % (4096, MAX_DATA_SIZE + 1)) # too big header size