Skip to content

Commit

Permalink
Merge f4cd08c into 76e8df0
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Sassoulas committed Jan 4, 2022
2 parents 76e8df0 + f4cd08c commit af0cf74
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 25 deletions.
27 changes: 27 additions & 0 deletions pydocstringformatter/formatting/base.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import abc
import tokenize


class Formatter:
"""Base class for docstring formatter."""

@abc.abstractmethod
def treat_token(self, tokeninfo: tokenize.TokenInfo) -> tokenize.TokenInfo:
"""Return a modified token."""


class StringFormatter(Formatter):
"""Base class for formatter that only modifies the string content."""

@abc.abstractmethod
def _treat_string(self, tokeninfo: tokenize.TokenInfo) -> str:
"""Return a modified string."""

def treat_token(self, tokeninfo: tokenize.TokenInfo) -> tokenize.TokenInfo:
return tokenize.TokenInfo(
tokeninfo.type,
self._treat_string(tokeninfo),
tokeninfo.start,
tokeninfo.end,
tokeninfo.line,
)
26 changes: 1 addition & 25 deletions pydocstringformatter/formatting/formatter.py
Original file line number Diff line number Diff line change
@@ -1,31 +1,7 @@
import abc
import re
import tokenize


class Formatter:
"""Base class for docstring formatter"""

@abc.abstractmethod
def treat_token(self, tokeninfo: tokenize.TokenInfo) -> tokenize.TokenInfo:
"""Return a modified token"""


class StringFormatter(Formatter):
"""Base class for formatter that only modifies the string content"""

@abc.abstractmethod
def _treat_string(self, tokeninfo: tokenize.TokenInfo) -> str:
"""Return a modified string"""

def treat_token(self, tokeninfo: tokenize.TokenInfo) -> tokenize.TokenInfo:
return tokenize.TokenInfo(
tokeninfo.type,
self._treat_string(tokeninfo),
tokeninfo.start,
tokeninfo.end,
tokeninfo.line,
)
from pydocstringformatter.formatting.base import StringFormatter


class BeginningQuotesFormatter(StringFormatter):
Expand Down

0 comments on commit af0cf74

Please sign in to comment.