leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(python): fixed bugs + added unittests (#189)

Browse Source
This commit is contained in:
Colin Kennedy
2024-08-02 07:21:10 -07:00
committed by GitHub
parent b2942f546c
commit 8614bcb6c6
4 changed files with 127 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

166
tests/neogen/python_google_spec.lua
View File

@@ -460,43 +460,42 @@ describe("python: google_docstrings", function()
assert.equal(expected, result)
end)
-- TODO: This is broken. Fix it!
-- This used to work but broke later on, it seems - https://github.com/danymat/neogen/pull/142
-- it("lists only one entry per-raised type", function()
-- local source = [[
-- def foo(bar):|cursor|
-- if bar:
-- raise TypeError("THING")
--
-- if GLOBAL:
-- raise ValueError("asdffsd")
--
-- raise TypeError("BLAH")
-- ]]
--
-- local expected = [[
-- def foo(bar):
-- """[TODO:description]
--
-- Args:
-- bar ([TODO:parameter]): [TODO:description]
--
-- Raises:
-- TypeError: [TODO:throw]
-- ValueError: [TODO:throw]
-- """
-- if bar:
-- raise TypeError("THING")
--
-- raise ValueError("asdffsd")
--
-- raise TypeError("BLAH")
-- ]]
--
-- local result = _make_python_docstring(source)
--
-- assert.equal(expected, result)
-- end)
it("lists only one entry per-raised type", function()
local source = [[
def foo(bar):|cursor|
if bar:
raise TypeError("THING")
if GLOBAL:
raise ValueError("asdffsd")
raise TypeError("BLAH")
]]
local expected = [[
def foo(bar):
"""[TODO:description]
Args:
bar ([TODO:parameter]): [TODO:description]
Raises:
TypeError: [TODO:throw]
ValueError: [TODO:throw]
"""
if bar:
raise TypeError("THING")
if GLOBAL:
raise ValueError("asdffsd")
raise TypeError("BLAH")
]]
local result = make_google_docstrings(source)
assert.equal(expected, result)
end)
it("works with modules, even if they are nested", function()
local source = [[
@@ -540,43 +539,41 @@ describe("python: google_docstrings", function()
assert.equal(expected, result)
end)
-- TODO: This is broken. Fix it!
-- This used to work but broke later on, it seems - https://github.com/danymat/neogen/pull/142
-- it("works with 2+ raises", function()
-- local source = [[
-- def foo(bar):|cursor|
-- if bar:
-- raise TypeError("THING")
--
-- if GLOBAL:
-- raise TypeError("asdffsd")
--
-- raise TypeError("BLAH")
-- ]]
--
-- local expected = [[
-- def foo(bar):
-- """[TODO:description]
--
-- Args:
-- bar ([TODO:parameter]): [TODO:description]
--
-- Raises:
-- TypeError: [TODO:throw]
-- """
-- if bar:
-- raise TypeError("THING")
--
-- if GLOBAL:
-- raise TypeError("asdffsd")
--
-- raise TypeError("BLAH")
-- ]]
--
-- local result = _make_python_docstring(source)
--
-- assert.equal(expected, result)
-- end)
it("works with 2+ raises", function()
local source = [[
def foo(bar):|cursor|
if bar:
raise TypeError("THING")
if GLOBAL:
raise TypeError("asdffsd")
raise TypeError("BLAH")
]]
local expected = [[
def foo(bar):
"""[TODO:description]
Args:
bar ([TODO:parameter]): [TODO:description]
Raises:
TypeError: [TODO:throw]
"""
if bar:
raise TypeError("THING")
if GLOBAL:
raise TypeError("asdffsd")
raise TypeError("BLAH")
]]
local result = make_google_docstrings(source)
assert.equal(expected, result)
end)
end)
describe("func - returns", function()
@@ -745,6 +742,27 @@ describe("python: google_docstrings", function()
assert.equal(expected, result)
end)
it("works with type-hints as expected", function()
local source = [[
def foo() -> typing.Generator[str]:|cursor|
yield "asdfsfd"
]]
local expected = [[
def foo() -> typing.Generator[str]:
"""[TODO:description]
Yields:
[TODO:description]
"""
yield "asdfsfd"
]]
local result = make_google_docstrings(source)
assert.equal(expected, result)
end)
it("works when doing yield + return at once", function()
local source = [[
def items(value):|cursor|