bcoe / bcoe/secure-smtpd

TypeError: __init__() got an unexpected keyword argument 'debug'

Open
#21 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
123
Forks
41
PR merge metrics
No merged PRs in 30d

Description

Documentation on pypi and github says it should be instantiated like this:

```
SMTPServer(
self,
('0.0.0.0', 465),
None,
require_authentication=True,
ssl=True,
certfile='examples/server.crt',
keyfile='examples/server.key',
credential_validator=FakeCredentialValidator(),
debug=True
)
```

However it is not correct as constructor in recent release does not have debug parameter and it results in:

```
TypeError: __init__() got an unexpected keyword argument 'debug'
```

Please fix documentation or implement debugging and debug argument.

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the documented SMTPServer constructor example on PyPI and GitHub with the recent release's actual constructor. Decide whether the intended fix is to remove debug=True from the documentation or restore the debug argument, then verify that the example no longer raises the reported TypeError.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.