Skip to content

Commit

Permalink
Merge pull request #228 from cfhowes/normalize_names_improvements
Browse files Browse the repository at this point in the history 
Some improvements to parsing when using normalize_names=True.
  • Loading branch information
@xnuinside
xnuinside authored Jan 11, 2024
2 parents 41757cb + 24d5577 commit 9cff297
Show file tree
Hide file tree
Showing 5 changed files with 269 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.txt
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
**v1.0.1**
### Minor Fixes
1. When using `normalize_names=True` do not remove `[]` from types like `decimal(21)[]`.
2. When using `normalize_names=True` ensure that `"complex"."type"` style names convert to `complex.type`.

**v1.0.0**
In output structure was done important changes that can in theory breaks code.

Expand Down
2 changes: 1 addition & 1 deletion simple_ddl_parser/ddl_parser.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ def p_id(self, p):
delimiters_to_end = ["`", '"', "]"]
p[0] = p[1]

if self.normalize_names:
if self.normalize_names and len(p[0]) > 2:
for num, symbol in enumerate(delimiters_to_start):
if p[0].startswith(symbol) and p[0].endswith(delimiters_to_end[num]):
p[0] = p[0][1:-1]
Expand Down
2 changes: 1 addition & 1 deletion simple_ddl_parser/dialects/sql.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ def process_type(self, _type: Union[str, List], p_list: List, p: List) -> str:
p[0] = {"property": {"distkey": True}}
_type = _type.split("distkey")[0]

_type = _type.strip().replace('" . "', '"."')
_type = _type.strip().replace(" . ", ".")

_type = self.process_array_types(_type, p_list)
return _type
Expand Down
96 changes: 96 additions & 0 deletions tests/test_references.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -475,3 +475,99 @@ def test_foreigen_keys():
"types": [],
}
assert result == expected


def test_compound_foreigen_keys():
"""
Tests that a compound foreign key will be properly output.
"""
result = DDLParser(
"""
CREATE TABLE "linked_to" (
"id" int PRIMARY KEY,
"complexpk_complex_id" int,
"complexpk_date_part" int,
"comment" varchar,
CONSTRAINT "id_date_part_ibfk" FOREIGN KEY ("complexpk_complex_id", "complexpk_date_part")
REFERENCES "complexpk" ("complex_id", "date_part")
) ENGINE=InnoDB CHARACTER SET utf8;
""",
normalize_names=True,
).run(group_by_type=True)
expected = {
"ddl_properties": [],
"domains": [],
"schemas": [],
"sequences": [],
"tables": [
{
"table_name": "linked_to",
"schema": None,
"primary_key": ["id"],
"columns": [
{
"name": "id",
"type": "int",
"size": None,
"references": None,
"unique": False,
"nullable": False,
"default": None,
"check": None,
},
{
"name": "complexpk_complex_id",
"type": "int",
"size": None,
"references": None,
"unique": False,
"nullable": True,
"default": None,
"check": None,
},
{
"name": "complexpk_date_part",
"type": "int",
"size": None,
"references": None,
"unique": False,
"nullable": True,
"default": None,
"check": None,
},
{
"name": "comment",
"type": "varchar",
"size": None,
"references": None,
"unique": False,
"nullable": True,
"default": None,
"check": None,
},
],
"alter": {},
"checks": [],
"index": [],
"partitioned_by": [],
"constraints": {
"references": [
{
"table": "complexpk",
"columns": ["complex_id", "date_part"],
"schema": None,
"on_delete": None,
"on_update": None,
"deferrable_initially": None,
"name": ["complexpk_complex_id", "complexpk_date_part"],
"constraint_name": "id_date_part_ibfk",
}
]
},
"tablespace": None,
"table_properties": {"engine=innodb": "CHARACTER", "set": "utf8"},
}
],
"types": [],
}
assert result == expected
166 changes: 166 additions & 0 deletions tests/test_simple_ddl_parser.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -804,6 +804,119 @@ def test_arrays():
assert expected == parse_results


def test_arrays_with_normalized_names():
parse_results = DDLParser(
"""
CREATE table arrays_2 (
field_1 decimal(21)[] not null
,field_2 integer(61) array not null
,field_3 varchar array not null default '{"none"}'
,squares integer[3][3] not null default '{1}'
,schedule text[][]
,pay_by_quarter integer[]
,pay_by_quarter_2 integer ARRAY[4]
,pay_by_quarter_3 integer ARRAY
) ;
""",
normalize_names=True,
).run()
expected = [
{
"columns": [
{
"name": "field_1",
"type": "decimal[]",
"size": 21,
"references": None,
"unique": False,
"nullable": False,
"default": None,
"check": None,
},
{
"name": "field_2",
"type": "integer[]",
"size": 61,
"references": None,
"unique": False,
"nullable": False,
"default": None,
"check": None,
},
{
"name": "field_3",
"type": "varchar[]",
"size": None,
"references": None,
"unique": False,
"nullable": False,
"default": "'{\"none\"}'",
"check": None,
},
{
"name": "squares",
"type": "integer[3][3]",
"size": None,
"references": None,
"unique": False,
"nullable": False,
"default": "'{1}'",
"check": None,
},
{
"name": "schedule",
"type": "text[][]",
"size": None,
"references": None,
"unique": False,
"nullable": True,
"default": None,
"check": None,
},
{
"name": "pay_by_quarter",
"type": "integer[]",
"size": None,
"references": None,
"unique": False,
"nullable": True,
"default": None,
"check": None,
},
{
"name": "pay_by_quarter_2",
"type": "integer[4]",
"size": None,
"references": None,
"unique": False,
"nullable": True,
"default": None,
"check": None,
},
{
"name": "pay_by_quarter_3",
"type": "integer[]",
"size": None,
"references": None,
"unique": False,
"nullable": True,
"default": None,
"check": None,
},
],
"primary_key": [],
"index": [],
"alter": {},
"checks": [],
"table_name": "arrays_2",
"tablespace": None,
"schema": None,
"partitioned_by": [],
}
]
assert expected == parse_results


def test_like_statement():
ddl = """
Expand Down Expand Up @@ -994,6 +1107,59 @@ def test_group_by_type_output():
assert result == expected


def test_enum_with_normalized_names():
expected = {
"domains": [],
"ddl_properties": [],
"schemas": [],
"sequences": [],
"tables": [
{
"alter": {},
"checks": [],
"columns": [
{
"check": None,
"default": None,
"name": "content_type",
"nullable": True,
"references": None,
"size": None,
"type": "schema--notification.ContentType",
"unique": False,
}
],
"index": [],
"partitioned_by": [],
"primary_key": [],
"schema": "schema--notification",
"table_name": "notification",
"tablespace": None,
}
],
"types": [
{
"base_type": "ENUM",
"properties": {"values": ["'TEXT'", "'MARKDOWN'", "'HTML'"]},
"schema": "schema--notification",
"type_name": "ContentType",
}
],
}

ddl = """
CREATE TYPE "schema--notification"."ContentType" AS
ENUM ('TEXT','MARKDOWN','HTML');
CREATE TABLE "schema--notification"."notification" (
content_type "schema--notification"."ContentType"
);
"""

result = DDLParser(ddl, normalize_names=True).run(group_by_type=True)

assert result == expected


def test_do_not_fail_on_brackets_in_default():
ddl = """
Expand Down

0 comments on commit 9cff297

Please sign in to comment.