Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Doc/library/symtable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,10 @@ Examining Symbol Tables
Return a tuple containing names of :term:`free (closure) variables <closure variable>`
in this function.

.. method:: get_cells()

Return a tuple containing the names of cell variables in this table.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

try formatting like the entry for get_frees with :term:



.. class:: Class

Expand Down Expand Up @@ -353,6 +357,12 @@ Examining Symbol Tables
Return the namespace bound to this name. If more than one or no namespace
is bound to this name, a :exc:`ValueError` is raised.

.. method:: is_cell()

Return ``True`` if the symbol is a cell variable.

.. versionadded:: 3.15
Copy link
Member

@iritkatriel iritkatriel Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's put this next to is_free.



.. _symtable-cli:

Expand Down
13 changes: 13 additions & 0 deletions Lib/symtable.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ class Function(SymbolTable):
__frees = None
__globals = None
__nonlocals = None
__cells = None

def __idents_matching(self, test_func):
return tuple(ident for ident in self.get_identifiers()
Expand Down Expand Up @@ -229,6 +230,14 @@ def get_frees(self):
self.__frees = self.__idents_matching(is_free)
return self.__frees

def get_cells(self):
"""Return a tuple of cell variable names in the table.
"""
if self.__cells is None:
is_cell = lambda x: _get_scope(x) == CELL
self.__cells = self.__idents_matching(is_cell)
return self.__cells


class Class(SymbolTable):

Expand Down Expand Up @@ -342,6 +351,10 @@ def is_free(self):
"""
return bool(self.__scope == FREE)

def is_cell(self):
"""Return *True* if the symbol is a cell variable."""
return bool(self.__scope == CELL)

def is_free_class(self):
"""Return *True* if a class-scoped symbol is free from
the perspective of a method."""
Expand Down
4 changes: 4 additions & 0 deletions Lib/test/test_symtable.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@ def test_function_info(self):
self.assertEqual(sorted(func.get_locals()), expected)
self.assertEqual(sorted(func.get_globals()), ["bar", "glob", "some_assigned_global_var"])
self.assertEqual(self.internal.get_frees(), ("x",))
self.assertEqual(self.spam.get_cells(), ("some_var", "x",))

def test_globals(self):
self.assertTrue(self.spam.lookup("glob").is_global())
Expand Down Expand Up @@ -284,6 +285,9 @@ def test_local(self):
def test_free(self):
self.assertTrue(self.internal.lookup("x").is_free())

def test_cells(self):
self.assertTrue(self.spam.lookup("x").is_cell())

def test_referenced(self):
self.assertTrue(self.internal.lookup("x").is_referenced())
self.assertTrue(self.spam.lookup("internal").is_referenced())
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add symtable.is_cell() and get_cells() methods for cell variable analysis.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add :meth:`symtable.SymbolTable.get_cells` and
:meth:`symtable.Symbol.is_cell` methods.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let add an entry to Doc/whatsnew/3.15.rst as well.

Loading