Skip to content

Commit 540c49e

Browse files
committed
Get rid of unused snippet
1 parent 346b5e8 commit 540c49e

File tree

3 files changed

+11
-66
lines changed

3 files changed

+11
-66
lines changed

sphinxnotes/snippet/__init__.py

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -158,35 +158,18 @@ def __getstate__(self) -> Dict[str,Any]:
158158

159159

160160
@dataclass
161-
class Notes(Snippet):
162-
"""An abstract :class:`Snippet` subclass."""
161+
class Code(Snippet):
162+
"""A code block with description."""
163163
description:List[nodes.Body]
164-
165-
def nodes(self) -> List[nodes.Node]:
166-
return self.description.copy()
167-
168-
169-
def excerpt(self) -> str:
170-
return self.description[0].astext().replace('\n', '')
171-
172-
173-
def __getstate__(self) -> Dict[str,Any]:
174-
"""Implement :py:meth:`pickle.object.__getstate__`."""
175-
self.description = [x.deepcopy() for x in self.description]
176-
return super().__getstate__()
177-
178-
179-
@dataclass
180-
class Code(Notes):
181-
"""A piece of :class:`Notes` with code block."""
182164
block:nodes.literal_block
183165

184166
def nodes(self) -> List[nodes.Node]:
185-
return super().nodes() + [self.block]
167+
return self.description.copy() + [self.block]
186168

187169

188170
def excerpt(self) -> str:
189-
return '/%s/ ' % self.language() + super().excerpt()
171+
return '/%s/ ' % self.language() + \
172+
self.description[0].astext().replace('\n', '')
190173

191174

192175
@classmethod
@@ -198,41 +181,13 @@ def language(self) -> str:
198181
"""Return the (programing) language that appears in code."""
199182
return self.block['language']
200183

184+
201185
def __getstate__(self) -> Dict[str,Any]:
202-
"""Implement :py:meth:`pickle.object.__getstate__`."""
186+
self.description = [x.deepcopy() for x in self.description]
203187
self.block = self.block.deepcopy()
204188
return super().__getstate__()
205189

206190

207-
@dataclass
208-
class Procedure(Notes):
209-
"""
210-
A piece of :class:`Notes` that describes a sequence of :class:`Code`
211-
to do something.
212-
"""
213-
steps:List[Code]
214-
215-
def nodes(self) -> List[nodes.Node]:
216-
nodes_ = []
217-
for code in self.steps:
218-
nodes_ += code.nodes()
219-
return super().nodes() + nodes_
220-
221-
222-
def excerpt(self) -> str:
223-
return '/%s/ ' % ','.join(self.languages()) + super().excerpt()
224-
225-
226-
@classmethod
227-
def kind(cls) -> str:
228-
return 'p'
229-
230-
231-
def languages(self) -> Set[str]:
232-
"""Return the (programing) language(s) that appear in procedure."""
233-
return set(c.block['language'] for c in self.steps)
234-
235-
236191
def read_partial_file(filename:str, scope:Tuple[int,Optional[int]]) -> List[str]:
237192
lines = []
238193
with open(filename, "r") as f:
@@ -242,7 +197,6 @@ def read_partial_file(filename:str, scope:Tuple[int,Optional[int]]) -> List[str]
242197
lines.append(line.strip('\n'))
243198
return lines
244199

245-
246200
def merge_scopes(scopes:List[Tuple[int,int]]) -> List[Tuple[int,int]]:
247201
""""Merge the overlap scope, the pass-in scopes must be sorted."""
248202
merged = [scopes[0]]

sphinxnotes/snippet/ext.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
from sphinx.util import logging
2222

2323
from .config import Config
24-
from . import Snippet, Headline, Notes, Code
24+
from . import Snippet, Headline, Code
2525
from .picker import pick_doctitle, pick_codes
2626
from .cache import Cache, Item
2727
from .keyword import Extractor
@@ -36,7 +36,7 @@
3636

3737
def extract_keywords(s:Snippet) -> List[str]:
3838
# TODO: Deal with more snippet
39-
if isinstance(s, Notes):
39+
if isinstance(s, Code):
4040
return extractor.extract('\n'.join(map(lambda x:x.astext(), s.description)),
4141
top_n=10)
4242
elif isinstance(s, Headline):

sphinxnotes/snippet/picker.py

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
from docutils import nodes
1515

16-
from . import Headline, Code, Procedure
16+
from . import Headline, Code
1717
from .utils.titlepath import resolve_doctitle
1818

1919

@@ -36,8 +36,6 @@ class CodePicker(nodes.SparseNodeVisitor):
3636
"""Node visitor for picking code snippet from document."""
3737
# Code snippets that picked from document
3838
codes:List[Code]
39-
# Procedures that picked from document, TODO
40-
procedures:List[Procedure]
4139
# (container, pointer) that Recording the read pointer inside container
4240
offset:Dict[nodes.Node,int]
4341
# List of unsupported languages (:class:`pygments.lexers.Lexer`)
@@ -47,7 +45,6 @@ class CodePicker(nodes.SparseNodeVisitor):
4745
def __init__(self, document:nodes.document) -> None:
4846
super().__init__(document)
4947
self.codes = []
50-
self.procedures = []
5148
self.offset = {}
5249

5350

@@ -82,16 +79,10 @@ def visit_literal_block(self, node:nodes.literal_block) -> None:
8279
block=node))
8380

8481

85-
def visit_enumerated_list(self, node:nodes.enumerated_list) -> None:
86-
pass
87-
88-
def depart_enumerated_list(self, node:nodes.enumerated_list) -> None:
89-
pass
90-
91-
9282
def unknown_visit(self, node:nodes.Node) -> None:
9383
pass # Ignore any unknown node
9484

85+
9586
def unknown_departure(self, node:nodes.Node) -> None:
9687
pass # Ignore any unknown node
9788

0 commit comments

Comments
 (0)