After Justin's spec clean-up

Author: hwwhww

eth/beacon/enums/validator_status_codes.py

@@ -5,6 +5,5 @@ class ValidatorStatusCode(IntEnum):
     PENDING_ACTIVATION = 0
     ACTIVE = 1
     PENDING_EXIT = 2
-    PENDING_WITHDRAW = 3
-    WITHDRAWN = 4
-    PENALIZED = 127
+    EXITED_WITHOUT_PENALTY = 3
+    EXITED_WITH_PENALTY = 4

eth/beacon/helpers.py

@@ -217,13 +217,12 @@ def get_attestation_indices(crystallized_state: 'CrystallizedState',
 @to_tuple
 def get_active_validator_indices(validators: Sequence['ValidatorRecord']) -> Iterable[int]:
     """
-    Return the active validators.
+    Gets indices of active validators from ``validators``.
     """
-    o = []
-    for index, validator in enumerate(validators):
-        if (validator.status == ValidatorStatusCode.ACTIVE):
-            o.append(index)
-    return o
+    return [
+        i for i, v in enumerate(validators)
+        if v.status in [ValidatorStatusCode.ACTIVE, ValidatorStatusCode.PENDING_EXIT]
+    ]
 
 
 #
@@ -235,7 +234,6 @@ def _get_shards_and_committees_for_shard_indices(
         start_shard: int,
         shard_count: int) -> Iterable[ShardAndCommittee]:
     """
-    FIXME
     Returns filled [ShardAndCommittee] tuple.
     """
     for index, indices in enumerate(shard_indices):
@@ -255,7 +253,7 @@ def get_new_shuffling(*,
                       shard_count: int) -> Iterable[Iterable[ShardAndCommittee]]:
     """
     Return shuffled ``shard_and_committee_for_slots`` (``[[ShardAndCommittee]]``) of
-    the given active ``validators``.
+    the given active ``validators`` using ``seed`` as entropy.
 
     Two-dimensional:
     The first layer is ``slot`` number
@@ -302,9 +300,10 @@ def get_new_shuffling(*,
         shard_count // cycle_length,
         active_validators_size // cycle_length // target_committee_size,
     )
+    # Shuffle with seed
     shuffled_active_validator_indices = shuffle(active_validators, seed)
 
-    # Split the shuffled list into cycle_length pieces
+    # Split the shuffled list into epoch_length pieces
     validators_per_slot = split(shuffled_active_validator_indices, cycle_length)
     for index, slot_indices in enumerate(validators_per_slot):
         # Split the shuffled list into committees_per_slot pieces

eth/beacon/utils/random.py

@@ -36,6 +36,8 @@ def shuffle(values: Sequence[Any],
     """
     values_count = len(values)
 
+    # The range of the RNG places an upper-bound on the size of the list that
+    # may be shuffled. It is a logic error to supply an oversized list.
     if values_count >= RAND_MAX:
         raise ValueError(
             "values_count (%s) should less than RAND_MAX (%s)." %
@@ -84,13 +86,13 @@ def shuffle(values: Sequence[Any],
 
 
 @to_tuple
-def split(seq: Sequence[TItem], split_count: int) -> Iterable[Any]:
+def split(values: Sequence[TItem], split_count: int) -> Iterable[Any]:
     """
-    Returns the split ``seq`` in ``split_count`` pieces in protocol.
+    Returns the split ``values`` in ``split_count`` pieces in protocol.
     Spec: https://github.com/ethereum/eth2.0-specs/blob/70cef14a08de70e7bd0455d75cf380eb69694bfb/specs/core/0_beacon-chain.md#helper-functions  # noqa: E501
     """
-    list_length = len(seq)
+    list_length = len(values)
     return [
-        seq[(list_length * i // split_count): (list_length * (i + 1) // split_count)]
+        values[(list_length * i // split_count): (list_length * (i + 1) // split_count)]
         for i in range(split_count)
     ]

eth/utils/numeric.py

@@ -101,7 +101,7 @@ def clamp(inclusive_lower_bound: int,
         return value
 
 
-def int_sqrt(value: int) -> int:
+def integer_squareroot(value: int) -> int:
     """
     Return the largest integer ``x`` such that ``x**2 <= value``.
     Ref: https://en.wikipedia.org/wiki/Integer_square_root

tests/beacon/test_helpers.py

@@ -416,4 +416,11 @@ def test_get_active_validator_indices(sample_validator_record_params):
         status=ValidatorStatusCode.PENDING_EXIT,
     )
     active_validator_indices = get_active_validator_indices(validators)
+    assert len(active_validator_indices) == 3
+
+    # Make one validator becomes PENDING_EXIT.
+    validators[0] = validators[0].copy(
+        status=ValidatorStatusCode.EXITED_WITHOUT_PENALTY,
+    )
+    active_validator_indices = get_active_validator_indices(validators)
     assert len(active_validator_indices) == 2

tests/core/numeric-utils/test_int_sqrt.py renamed to tests/core/numeric-utils/test_integer_squareroot.py

@@ -1,7 +1,7 @@
 import pytest
 
 from eth.utils.numeric import (
-    int_sqrt,
+    integer_squareroot,
 )
 
 
@@ -21,10 +21,10 @@
         (-1, ValueError()),
     )
 )
-def test_int_sqrt(value, expected):
+def test_integer_squareroot(value, expected):
     if isinstance(expected, Exception):
         with pytest.raises(ValueError):
-            int_sqrt(value)
+            integer_squareroot(value)
     else:
-        actual = int_sqrt(value)
+        actual = integer_squareroot(value)
         assert actual == expected