Added __all__.

git-svn-id: file:///home/phd/archive/SVN/bookmarks_db/trunk@318 fdd5c36f-1aea-0310-aeeb-c58d7e2b6c23

diff --git a/Robots/bkmk_rforking.py b/Robots/bkmk_rforking.py
index 843a0d27d939f3ca3e6db54f5f8ae48095837bda..d33c38d5a9d7a6f046aebde0d10cde82bbdbd0ce 100644 (file)
--- a/Robots/bkmk_rforking.py
+++ b/Robots/bkmk_rforking.py
@@ -10,14 +10,19 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['robot_forking']
+
+
+import sys, os
+
 try:
-   import cPickle
-   pickle = cPickle
+   import cPickle as pickle
 except ImportError:
    import pickle
 
-import sys, os
 from subproc import Subprocess, RecordFile
+from bkmk_objects import Robot
+
 
 # This is to catch 'close failed: [Errno 9] Bad file descriptor' message
 # from os.close() in Subprocess.die() and errors from from the subprocess.
@@ -42,8 +47,6 @@ def restart_subp(log):
    subp_pipe = RecordFile(check_subp)
 
 
-from bkmk_objects import Robot
-
 class robot_forking(Robot):
    def check_url(self, bookmark):
       if not check_subp:
@@ -81,6 +84,5 @@ class robot_forking(Robot):
       # Tested
       return 1
 
-
    def stop(self):
       stop_subp(None) # Stop subprocess; do not log restarting

diff --git a/Robots/bkmk_rforking_sub.py b/Robots/bkmk_rforking_sub.py
index 36338f42d6d52d4e80570cca0507eba83511c551..e392080697344298d388c72cfeb005bc20c63e0a 100755 (executable)
--- a/Robots/bkmk_rforking_sub.py
+++ b/Robots/bkmk_rforking_sub.py
@@ -11,6 +11,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 1999-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = []
+
+
 import sys, os
 
 lib_dir = os.path.normpath(os.path.dirname(sys.argv[0]) + os.sep + os.pardir)

diff --git a/Robots/bkmk_rsimple.py b/Robots/bkmk_rsimple.py
index 8bfa4298299f0c3b9842cdc0fa071b361ed8cd48..871082fe4a0113eddab4435582443fc29db0d068 100644 (file)
--- a/Robots/bkmk_rsimple.py
+++ b/Robots/bkmk_rsimple.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['robot_simple', 'get_error']
+
+
 import sys, os
 import time, urllib
 from base64 import b64encode
@@ -285,7 +288,6 @@ class robot_simple(Robot):
       # Tested
       return 1
 
-
    def finish_check_url(self, bookmark, fname=None):
       # Calculate these attributes even in case of an error
       if fname and os.path.exists(fname):

diff --git a/Robots/bkmk_rsimple_tos.py b/Robots/bkmk_rsimple_tos.py
index 25fa88f1d4fe7c514c63bfc0aa3751cc074a3463..df1827c9c1b8cb70465e27fa8bb9b490770906f4 100644 (file)
--- a/Robots/bkmk_rsimple_tos.py
+++ b/Robots/bkmk_rsimple_tos.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['robot_simple_tos']
+
+
 import socket
 socket.setdefaulttimeout(900)
 

diff --git a/Storage/bkmk_stflad.py b/Storage/bkmk_stflad.py
index 86c42b379273f59633b8c7ce40ab4b201204fd1b..ddcdc63bc919fcc3eea4571b0ee23950a62c3c16 100644 (file)
--- a/Storage/bkmk_stflad.py
+++ b/Storage/bkmk_stflad.py
@@ -12,6 +12,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['storage_flad']
+
+
 import string
 from m_lib.flad import fladm
 from bkmk_objects import Folder, Bookmark, Ruler, Walker
@@ -58,17 +61,14 @@ Charset: %s
          b.keyword, b.comment.replace('\n', "\\n"),
          b.icon_href or '', b.icon or '', b.charset or ''))
 
-
    def ruler(self, r, level):
       self.outfile.write("\nLevel: %s\nRuler: YES\n" % (level+1))
 
-
    def store(self, root_folder):
       self.outfile = open(self.filename, 'w')
       root_folder.walk_depth(self)
       self.outfile.close()
 
-
    def unindent(self, old_level, new_level):
       while old_level > new_level:
          old_level = old_level - 1

diff --git a/Storage/bkmk_stjson.py b/Storage/bkmk_stjson.py
index 437ca6d414687e19f0e2a5f8504b4106f4f8691b..88429b639b793033abd64dd03fc7659327041ec0 100644 (file)
--- a/Storage/bkmk_stjson.py
+++ b/Storage/bkmk_stjson.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2010, 2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['storage_json']
+
+
 try:
    import json
 except ImportError:
@@ -104,7 +107,6 @@ class storage_json(Walker):
         outfile.close()
         del self.dict
 
-
     def load(self):
         infile = open(self.filename, 'rb')
         bkmk_s = infile.read()

diff --git a/Storage/bkmk_stpickle.py b/Storage/bkmk_stpickle.py
index 702cea58ffc2a3735a63bfe540feea7fe6021f82..c957bfe725a0bdead3a408567d94ab4dc77e18c2 100644 (file)
--- a/Storage/bkmk_stpickle.py
+++ b/Storage/bkmk_stpickle.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['storage_pickle']
+
+
 try:
    import cPickle
    pickle = cPickle
@@ -21,13 +24,11 @@ except ImportError:
 class storage_pickle:
    filename = "bookmarks_db.pickle"
 
-
    def store(self, root_folder):
       outfile = open(self.filename, 'wb')
       pickle.dump(root_folder, outfile, 1)
       outfile.close()
 
-
    def load(self):
       infile = open(self.filename, 'rb')
       root_folder = pickle.load(infile)

diff --git a/Writers/bkmk_wflad.py b/Writers/bkmk_wflad.py
index d5cb7e01d8645dd9bc50c77f01a152c5ee9a663b..a4e88fcb7c9cd27d8fb9f2283cf47ca7ece4dcff 100644 (file)
--- a/Writers/bkmk_wflad.py
+++ b/Writers/bkmk_wflad.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['writer_flad']
+
+
 import time
 from bkmk_objects import Writer
 
@@ -28,7 +31,6 @@ class writer_flad(Writer):
       Writer.__init__(self, outfile, prune)
       self.first_object = 1
 
-
    def start_folder(self, f, level):
       self.outfile.write("""
 Level: %d
@@ -38,7 +40,6 @@ Comment: %s
 LastModified: %s
 """ % (level, f.name, strftime(f.add_date), f.comment, f.last_modified or ''))
 
-
    def bookmark(self, b, level):
       self.outfile.write("""
 Level: %d

diff --git a/Writers/bkmk_wflad_err.py b/Writers/bkmk_wflad_err.py
index b7b29770c765e5de1fd345f304a01db439e4d231..5370d1be4a1ed0e550b7e9080c5f4e44a569278a 100644 (file)
--- a/Writers/bkmk_wflad_err.py
+++ b/Writers/bkmk_wflad_err.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['writer_flad_err']
+
+
 import time
 from bkmk_wflad import writer_flad
 

diff --git a/Writers/bkmk_whtml.py b/Writers/bkmk_whtml.py
index 00591b04ac0d2c8018365b6a9da7a17223510372..97a17e42cd4f500bce32c4dded37867bd5be3e4a 100644 (file)
--- a/Writers/bkmk_whtml.py
+++ b/Writers/bkmk_whtml.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['writer_html']
+
+
 from bkmk_objects import Writer, BKMK_FORMAT, quote_title
 
 

diff --git a/Writers/bkmk_wtxt.py b/Writers/bkmk_wtxt.py
index 628d9b2f08f2fcd2fb4bd5392ed79603ee0785f1..d39c63be955e3af1f68a051f2db8b738ce990722 100644 (file)
--- a/Writers/bkmk_wtxt.py
+++ b/Writers/bkmk_wtxt.py
@@ -10,11 +10,14 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
-ind_s = " "*4
+__all__ = ['writer_txt']
 
 
 from bkmk_objects import Writer
 
+ind_s = " "*4
+
+
 class writer_txt(Writer):
    filename = "dump.txt"
 

diff --git a/bkmk_objects.py b/bkmk_objects.py
index d15c38e52d440c2a7bc29a827b75e86953917d3a..27e621b898ba4cf89499aea7e49943a9915974dd 100644 (file)
--- a/bkmk_objects.py
+++ b/bkmk_objects.py
@@ -10,6 +10,12 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2000-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['Folder', 'Bookmark', 'Ruler', 'Walker', 'Writer', 'Robot',
+    'InverseLinker', 'Linear', 'make_linear', 'make_tree', 'break_tree',
+    'quote_title', 'unquote_title',
+]
+
+
 import os, cgi
 BKMK_FORMAT = os.environ.get("BKMK_FORMAT", "MOZILLA")
 

diff --git a/bkmk_parser.py b/bkmk_parser.py
index 2ec412c012c2e1c385bad0ad60349bdbb89e6f6f..e3b3db02532567aef8060c4546f1f3a6af6039e2 100644 (file)
--- a/bkmk_parser.py
+++ b/bkmk_parser.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 1997-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['BkmkParser']
+
+
 import sys, os
 from m_lib.net.www.html import HTMLParser
 from bkmk_objects import Folder, Bookmark, Ruler
@@ -46,14 +49,12 @@ class BkmkParser(HTMLParser):
       self.charset = ""
       self.recode = None
 
-
    def handle_data(self, data):
       if data:
          if DEFAULT_CHARSET:
             data = unicode(data, self.charset, "replace").encode(DEFAULT_CHARSET, "xmlcharrefreplace")
          self.accumulator += data
 
-
    # Mozilla - get charset
    def do_meta(self, attrs):
       http_equiv = ""
@@ -83,7 +84,6 @@ class BkmkParser(HTMLParser):
                else:
                   DEFAULT_CHARSET = locale.getpreferredencoding()
 
-
    def start_title(self, attrs):
       if DEFAULT_CHARSET:
          self.accumulator += '<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=%s">\n' % DEFAULT_CHARSET
@@ -92,7 +92,6 @@ class BkmkParser(HTMLParser):
    def end_title(self):
       self.accumulator += "</TITLE>"
 
-
    # Start root folder
    def start_h1(self, attrs):
       root_folder = Folder()
@@ -111,7 +110,6 @@ class BkmkParser(HTMLParser):
       debug("Root folder name: `%s'" % accumulator)
       self.root_folder.name = accumulator
 
-
    # Start a folder
    def start_h3(self, attrs):
       last_modified = None
@@ -137,7 +135,6 @@ class BkmkParser(HTMLParser):
       debug("Folder name: `%s'" % accumulator)
       self.current_folder.name = accumulator
 
-
    # Start a bookmark
    def start_a(self, attrs):
       add_date = None
@@ -180,7 +177,6 @@ class BkmkParser(HTMLParser):
       bookmark = self.current_folder[-1]
       bookmark.name = accumulator
 
-
    def flush(self):
       accumulator = self.accumulator
 
@@ -192,13 +188,11 @@ class BkmkParser(HTMLParser):
             current_object.comment += accumulator.strip()
             debug("Comment: `%s'" % current_object.comment)
 
-
    def start_dl(self, attrs):
       self.flush()
 
    do_dt = start_dl
 
-
    # End of folder
    def end_dl(self):
       self.flush()
@@ -214,19 +208,16 @@ class BkmkParser(HTMLParser):
          debug("FOLDER STACK is EMPTY!!! (2)")
       self.current_object = None
 
-
    def close(self):
       HTMLParser.close(self)
       if self.folder_stack:
          raise ValueError, "wrong folder stack: %s" % self.folder_stack
 
-
    def do_dd(self, attrs):
       pass
 
    do_p = do_dd
 
-
    # Start ruler
    def do_hr(self, attrs):
       self.flush()
@@ -235,17 +226,14 @@ class BkmkParser(HTMLParser):
       self.current_object = None
       self.objects += 1
 
-
    # BR in comment
    def do_br(self, attrs):
       self.accumulator += "<BR>"
 
-
    # Allow < in the text
    def unknown_starttag(self, tag, attrs):
       self.accumulator += "<%s>" % tag
 
-
    # Do not allow unknow end tags
    def unknown_endtag(self, tag):
       raise NotImplementedError("Unknow end tag `%s'" % tag)

diff --git a/parse_html/__init__.py b/parse_html/__init__.py
index 95ab357203fc8dadb0114c50ba55e63eaed2aef0..96fa6968a4e4a2b4cd3b5fbdde4875c85f89f9ca 100644 (file)
--- a/parse_html/__init__.py
+++ b/parse_html/__init__.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 1997-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['parse_html']
+
+
 import codecs
 
 universal_charset = "utf-8"

diff --git a/parse_html/beautifulsoup.py b/parse_html/beautifulsoup.py
index ec5542afbe0e72630a3297ec9593db6112c4623a..1b2d3a43c847a15f0080c9e41a4458b4d06bf4ee 100644 (file)
--- a/parse_html/beautifulsoup.py
+++ b/parse_html/beautifulsoup.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2007-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['parse_html']
+
+
 import re
 from sgmllib import SGMLParser, SGMLParseError
 from BeautifulSoup import BeautifulSoup, CData

diff --git a/parse_html/etreetidy.py b/parse_html/etreetidy.py
index 5d8970075e137ee8acd22c6af44da9d82c20629a..0b36ecd50c36c115d60fe58160d658850fde41c2 100644 (file)
--- a/parse_html/etreetidy.py
+++ b/parse_html/etreetidy.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2010, 2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['parse_html']
+
+
 from elementtidy import TidyHTMLTreeBuilder
 from .util import HTMLParser
 

diff --git a/parse_html/html5.py b/parse_html/html5.py
index 08fb6b1230d8b8e086ec329ba1b61bdc4f6c7214..a6443f1c32d97bd02be2450943a794ed0264e8ad 100644 (file)
--- a/parse_html/html5.py
+++ b/parse_html/html5.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2010, 2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['parse_html']
+
+
 from html5lib import HTMLParser as HTML5Parser
 from .util import HTMLParser
 

diff --git a/parse_html/htmlparser.py b/parse_html/htmlparser.py
index 0932873f14a9566b74d056feed7b261f1a9ce9a0..295df2bdabe6b9cacf839b3c4bea0a56a70c1d5f 100644 (file)
--- a/parse_html/htmlparser.py
+++ b/parse_html/htmlparser.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 1997-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['parse_html']
+
+
 from HTMLParser import HTMLParseError
 from m_lib.net.www.html import HTMLParser as _HTMLParser
 
@@ -29,7 +32,6 @@ class HTMLParser(_HTMLParser):
    def end_head(self):
       raise HTMLHeadDone()
 
-
    def do_meta(self, attrs):
       http_equiv = ""
       content = ""
@@ -54,7 +56,6 @@ class HTMLParser(_HTMLParser):
       if http_equiv == "refresh":
          self.refresh = content
 
-
    def start_title(self, attrs):
       self.accumulator = ''
 
@@ -62,7 +63,6 @@ class HTMLParser(_HTMLParser):
       if not self.title: # use only the first title
          self.title = self.accumulator
 
-
    def do_link(self, attrs):
       has_icon = False
       href = None

diff --git a/parse_html/lxml.py b/parse_html/lxml.py
index 30d43a42df57c58c084d94c1cc22aca0fefee39c..01dd7591d8a35e97bc90bdfdcb909fdef8c2adf8 100644 (file)
--- a/parse_html/lxml.py
+++ b/parse_html/lxml.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2010, 2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['parse_html']
+
+
 from lxml.html import parse
 from .util import HTMLParser
 

diff --git a/parse_html/util.py b/parse_html/util.py
index 12bab4cf0778d84f9460f62fb748233f7f4411cb..b26d9d916cb9f2b7591389d895495364b553a433 100644 (file)
--- a/parse_html/util.py
+++ b/parse_html/util.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 2010, 2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['HTMLParser']
+
+
 from HTMLParser import HTMLParser
 
 class HTMLParser(HTMLParser):

diff --git a/robots.py b/robots.py
index 4aa7372dfc11cfbb55d7e399711f6794597fade7..ca4f3c3ede51da08809601a4f437bf5f73be61ea 100644 (file)
--- a/robots.py
+++ b/robots.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 1997-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['import_robot', 'robot']
+
+
 from os import environ
 robot_name = environ.get("BKMK_ROBOT", "forking")
 

diff --git a/storage.py b/storage.py
index 5d309bf5a3a5c177f67d277c9b23120752f1d7ef..0e2b679874b3750b81d11f5e3323224e5c141fbb 100644 (file)
--- a/storage.py
+++ b/storage.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 1997-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['import_storage', 'storage']
+
+
 from os import environ
 storage_name = environ.get("BKMK_STORAGE", "pickle")
 

diff --git a/writers.py b/writers.py
index 46fb08a9d2e3621f76815845fe5e17e41252d22d..7a0ec8cf9f0600f2e7799446ddafe4d6bad17b14 100644 (file)
--- a/writers.py
+++ b/writers.py
@@ -10,6 +10,9 @@ __author__ = "Oleg Broytman <phd@phdru.name>"
 __copyright__ = "Copyright (C) 1997-2011 PhiloSoft Design"
 __license__ = "GNU GPL"
 
+__all__ = ['import_writer', 'writer']
+
+
 from os import environ
 writer_name = environ.get("BKMK_WRITER", "html")