2013-07-16 20:21:33 -04:00
|
|
|
#
|
|
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
|
|
# this work for additional information regarding copyright ownership.
|
|
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
# (the "License"); you may not use this file except in compliance with
|
|
|
|
# the License. You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
#
|
|
|
|
|
2014-08-16 19:59:34 -04:00
|
|
|
import os
|
2015-04-16 19:20:57 -04:00
|
|
|
import sys
|
2014-11-24 20:17:03 -05:00
|
|
|
import gc
|
|
|
|
from tempfile import NamedTemporaryFile
|
2017-08-01 18:12:23 -04:00
|
|
|
import threading
|
2014-08-16 19:59:34 -04:00
|
|
|
|
2016-09-14 16:37:35 -04:00
|
|
|
from pyspark.cloudpickle import print_exec
|
2017-04-11 15:18:31 -04:00
|
|
|
from pyspark.util import _exception_message
|
2016-09-14 16:37:35 -04:00
|
|
|
|
2015-04-16 19:20:57 -04:00
|
|
|
if sys.version < '3':
|
|
|
|
import cPickle as pickle
|
|
|
|
else:
|
|
|
|
import pickle
|
|
|
|
unicode = str
|
2014-09-03 14:49:45 -04:00
|
|
|
|
|
|
|
__all__ = ['Broadcast']
|
|
|
|
|
|
|
|
|
2012-10-19 13:24:49 -04:00
|
|
|
# Holds broadcasted data received from Java, keyed by its id.
|
2012-08-25 16:59:01 -04:00
|
|
|
_broadcastRegistry = {}
|
|
|
|
|
|
|
|
|
2012-10-19 13:24:49 -04:00
|
|
|
def _from_id(bid):
|
2012-08-25 16:59:01 -04:00
|
|
|
from pyspark.broadcast import _broadcastRegistry
|
2012-10-19 13:24:49 -04:00
|
|
|
if bid not in _broadcastRegistry:
|
|
|
|
raise Exception("Broadcast variable '%s' not loaded!" % bid)
|
|
|
|
return _broadcastRegistry[bid]
|
2012-08-25 16:59:01 -04:00
|
|
|
|
|
|
|
|
|
|
|
class Broadcast(object):
|
2014-08-06 15:58:24 -04:00
|
|
|
|
2013-12-29 20:15:07 -05:00
|
|
|
"""
|
2014-11-24 20:17:03 -05:00
|
|
|
A broadcast variable created with L{SparkContext.broadcast()}.
|
2013-12-29 20:15:07 -05:00
|
|
|
Access its value through C{.value}.
|
2014-11-24 20:17:03 -05:00
|
|
|
|
|
|
|
Examples:
|
|
|
|
|
|
|
|
>>> from pyspark.context import SparkContext
|
|
|
|
>>> sc = SparkContext('local', 'test')
|
|
|
|
>>> b = sc.broadcast([1, 2, 3, 4, 5])
|
|
|
|
>>> b.value
|
|
|
|
[1, 2, 3, 4, 5]
|
|
|
|
>>> sc.parallelize([0, 0]).flatMap(lambda x: b.value).collect()
|
|
|
|
[1, 2, 3, 4, 5, 1, 2, 3, 4, 5]
|
|
|
|
>>> b.unpersist()
|
|
|
|
|
|
|
|
>>> large_broadcast = sc.broadcast(range(10000))
|
2013-12-29 20:15:07 -05:00
|
|
|
"""
|
|
|
|
|
2014-11-24 20:17:03 -05:00
|
|
|
def __init__(self, sc=None, value=None, pickle_registry=None, path=None):
|
2013-12-29 20:15:07 -05:00
|
|
|
"""
|
2014-11-24 20:17:03 -05:00
|
|
|
Should not be called directly by users -- use L{SparkContext.broadcast()}
|
2013-12-29 20:15:07 -05:00
|
|
|
instead.
|
|
|
|
"""
|
2014-11-24 20:17:03 -05:00
|
|
|
if sc is not None:
|
|
|
|
f = NamedTemporaryFile(delete=False, dir=sc._temp_dir)
|
|
|
|
self._path = self.dump(value, f)
|
|
|
|
self._jbroadcast = sc._jvm.PythonRDD.readBroadcastFromFile(sc._jsc, self._path)
|
|
|
|
self._pickle_registry = pickle_registry
|
|
|
|
else:
|
|
|
|
self._jbroadcast = None
|
|
|
|
self._path = path
|
|
|
|
|
|
|
|
def dump(self, value, f):
|
2016-09-14 16:37:35 -04:00
|
|
|
try:
|
|
|
|
pickle.dump(value, f, 2)
|
|
|
|
except pickle.PickleError:
|
|
|
|
raise
|
|
|
|
except Exception as e:
|
2017-04-11 15:18:31 -04:00
|
|
|
msg = "Could not serialize broadcast: %s: %s" \
|
|
|
|
% (e.__class__.__name__, _exception_message(e))
|
2016-09-14 16:37:35 -04:00
|
|
|
print_exec(sys.stderr)
|
|
|
|
raise pickle.PicklingError(msg)
|
2014-11-24 20:17:03 -05:00
|
|
|
f.close()
|
|
|
|
return f.name
|
|
|
|
|
|
|
|
def load(self, path):
|
|
|
|
with open(path, 'rb', 1 << 20) as f:
|
2015-04-16 19:20:57 -04:00
|
|
|
# pickle.load() may create lots of objects, disable GC
|
|
|
|
# temporary for better performance
|
|
|
|
gc.disable()
|
|
|
|
try:
|
|
|
|
return pickle.load(f)
|
|
|
|
finally:
|
|
|
|
gc.enable()
|
2014-08-16 19:59:34 -04:00
|
|
|
|
2014-09-03 14:49:45 -04:00
|
|
|
@property
|
|
|
|
def value(self):
|
|
|
|
""" Return the broadcasted value
|
|
|
|
"""
|
2014-11-24 20:17:03 -05:00
|
|
|
if not hasattr(self, "_value") and self._path is not None:
|
|
|
|
self._value = self.load(self._path)
|
2014-09-03 14:49:45 -04:00
|
|
|
return self._value
|
|
|
|
|
2014-08-16 19:59:34 -04:00
|
|
|
def unpersist(self, blocking=False):
|
2014-09-16 15:51:58 -04:00
|
|
|
"""
|
2016-04-06 13:46:34 -04:00
|
|
|
Delete cached copies of this broadcast on the executors. If the
|
|
|
|
broadcast is used after this is called, it will need to be
|
|
|
|
re-sent to each executor.
|
|
|
|
|
|
|
|
:param blocking: Whether to block until unpersisting has completed
|
2014-09-16 15:51:58 -04:00
|
|
|
"""
|
2014-11-24 20:17:03 -05:00
|
|
|
if self._jbroadcast is None:
|
|
|
|
raise Exception("Broadcast can only be unpersisted in driver")
|
2014-08-16 19:59:34 -04:00
|
|
|
self._jbroadcast.unpersist(blocking)
|
2016-04-06 13:46:34 -04:00
|
|
|
|
|
|
|
def destroy(self):
|
|
|
|
"""
|
|
|
|
Destroy all data and metadata related to this broadcast variable.
|
|
|
|
Use this with caution; once a broadcast variable has been destroyed,
|
|
|
|
it cannot be used again. This method blocks until destroy has
|
|
|
|
completed.
|
|
|
|
"""
|
|
|
|
if self._jbroadcast is None:
|
|
|
|
raise Exception("Broadcast can only be destroyed in driver")
|
|
|
|
self._jbroadcast.destroy()
|
2014-11-24 20:17:03 -05:00
|
|
|
os.unlink(self._path)
|
2012-08-25 16:59:01 -04:00
|
|
|
|
|
|
|
def __reduce__(self):
|
2014-11-24 20:17:03 -05:00
|
|
|
if self._jbroadcast is None:
|
|
|
|
raise Exception("Broadcast can only be serialized in driver")
|
2012-08-25 16:59:01 -04:00
|
|
|
self._pickle_registry.add(self)
|
2014-11-24 20:17:03 -05:00
|
|
|
return _from_id, (self._jbroadcast.id(),)
|
2014-08-16 19:59:34 -04:00
|
|
|
|
|
|
|
|
2017-08-01 18:12:23 -04:00
|
|
|
class BroadcastPickleRegistry(threading.local):
|
|
|
|
""" Thread-local registry for broadcast variables that have been pickled
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self):
|
|
|
|
self.__dict__.setdefault("_registry", set())
|
|
|
|
|
|
|
|
def __iter__(self):
|
|
|
|
for bcast in self._registry:
|
|
|
|
yield bcast
|
|
|
|
|
|
|
|
def add(self, bcast):
|
|
|
|
self._registry.add(bcast)
|
|
|
|
|
|
|
|
def clear(self):
|
|
|
|
self._registry.clear()
|
|
|
|
|
|
|
|
|
2014-08-16 19:59:34 -04:00
|
|
|
if __name__ == "__main__":
|
|
|
|
import doctest
|
2015-06-26 11:12:22 -04:00
|
|
|
(failure_count, test_count) = doctest.testmod()
|
|
|
|
if failure_count:
|
2018-03-08 06:38:34 -05:00
|
|
|
sys.exit(-1)
|